vtalbot/markdown

Laravel 5 的 Markdown 编译器

3.0.0 2021-03-01 18:41 UTC

This package is auto-updated.

Last update: 2024-08-29 03:29:14 UTC


README

安装

对于 Laravel 4

  1. 运行 composer require vtalbot/markdown:1.5
  2. 运行 php artisan config:publish vtalbot/markdown
  3. 然后编辑 app/config/packages/vtalbot/markdown/config.php 以满足您的需求。
  4. 'VTalbot\Markdown\MarkdownServiceProvider', 添加到 app/config/app.php 中的 providers,并将 'Markdown' => 'VTalbot\Markdown\Facades\Markdown', 添加到 app/config/app.php 中的 aliases

对于 Laravel 5+

  1. 运行 composer require vtalbot/markdown:2.0
  2. 运行 php artisan vendor:publish --provider="VTalbot\Markdown\MarkdownServiceProvider"
  3. 然后编辑 config/markdown.php 以满足您的需求。
  4. VTalbot\Markdown\MarkdownServiceProvider::class 添加到 config/app.php 中的 providers,并将 'Markdown' => VTalbot\Markdown\Facades\Markdown::class 添加到 config/app.php 中的 aliases

使用方法

http://domain.name/test.md

如果 public 目录中不存在 test.md,则将在 app/markdown 目录中查找 test.md。如果找到,则需要编译并返回结果。

Markdown::make('file-in-markdown-directory');

或者,您也可以编译一个简单的字符串

Markdown::string('#test');

处理 Markdown 文件未找到的情况

Markdown::setNotFoundHandler(function($file) { return 'Markdown file not found'; });
Markdown::setNotFoundHandler('MarkdownController@missing');

配置

有关 Markdown 配置的更多信息,您可以参考 http://michelf.ca/projects/php-markdown/configuration

更新日志

2.0

  • 添加对 Laravel 5 的支持

1.5

  • 更改已废弃的依赖。
  • 添加 Markdown 文件未找到处理器。
  • 基于新的依赖添加配置。
  • 添加一些测试。