dillingham/notable

Markdown到静态内容

维护者

详细信息

github.com/dillingham/notable

源代码

问题

安装: 2

依赖: 0

建议者: 0

安全性: 0

星级: 4

关注者: 0

分支: 0

开放问题: 0

0.0.3 2022-12-03 19:39 UTC

Requires

Requires (Dev)

MIT 9707d280a09e08977ea4d24ff1da7b1a8634aafb

This package is auto-updated.

Last update: 2024-09-04 07:01:13 UTC

README

为Laravel提供的简单文档包。

php artisan notable:install

  • 在项目的根目录中添加一个docs文件夹，用于Markdown

  • 在resources/views中添加一个docs文件夹，用于页面布局

  • 将以下路由添加到routes/web.php的顶部

Route::markdown('docs', base_path('docs'));

第一个参数是根端点，第二个参数是Markdown文件夹的路径

项目中具有以下路径的文件

docs/getting-started/installation.md

在浏览器中会显示为这样

docs/getting-started/installation

注意：URL中的docs来自路由定义，它不是文件夹的名称。它可以更改。

待办事项

  • 缓存已渲染的HTML Markdown。如果修改时间大于最后缓存时间，则渲染
  • 添加文件夹和文件编号排序 1-入门 -> 1-安装
  • 添加设置路由辅助函数（见下文）
  • 添加“本页内容”部分的链接
  • 为“编辑页面”添加仓库配置
Route::markdown()
    ->directory(base_path('docs'))
    ->prefix('documentation')
    ->view('docs.show')
    ->sections(config('docs.sections'))