wappla/laravel-markdown-to-pdf

使用 markdown 生成 PDF 的简单方法

0.1.0 2019-04-05 08:17 UTC

This package is auto-updated.

Last update: 2024-09-05 20:56:14 UTC


README

Markdown 转 PDF

一个简单的 Laravel 包,用于将 markdown 文件转换为 PDF。

要求

  • Laravel > 5.5

安装

使用 composer 安装此包

 composer require 'wappla/laravel-markdown-to-pdf'

此包使用 Laravel 的自动发现功能,因此不需要注册服务提供者或别名。

使用方法

创建一个 blade 视图并添加 markdown 到 pdf 组件。在组件元素之间可以开始编写 markdown。

以下是一个简单的 example.blade.php 示例:

@component('MarkdownToPDF::layout')
# Hello
@endcomponent

要在浏览器中将其视为 PDF 文件,您可以这样做:

    return \MarkdownToPDF::loadView('example')->stream();

加载视图的标准目录是 resources/views。无需添加 blade.php 扩展名。如果您想指定自定义目录,可以使用点表示法。

    return \MarkdownToPDF::loadView('custom-directory.example')->stream();

将此视图存储在 storage 中

指定自定义文件名或留空以在 storage 中保存您的 PDF。

    return \MarkdownToPDF::loadView('example')->save('awesome-file.pdf');

PDF 将根据您的 Laravel 文件系统配置进行存储。如果您想指定自定义位置,可以创建自己的磁盘并向 save 方法添加第二个参数。

以下示例将 PDF 文件存储在 public 磁盘上

    return \MarkdownToPDF::loadView('example')->save('awesome-file.pdf', 'public');

配置

使用标准的 php artisan vendor:publish Laravel 命令并选择正确的数字或更具体地选择

发布所有配置和视图

php artisan vendor:publish --provider="Wappla\LaravelMarkdownToPDF\MarkdownToPDFServiceProvider"

仅发布视图

php artisan vendor:publish --tag="markdown-to-pdf-views"

仅发布配置

php artisan vendor:publish --tag="markdown-to-pdf-config"