通过以下链接搜索：
rex-devs / lara-docs-kit
一个Laravel文档包，可以在现有网站上添加多个文档部分，同时为每个部分选择自定义URL。
v1.0.0
2023-09-16 19:38 UTC
Requires
- php: ^8.1
- spatie/laravel-markdown: ^2.3
- spatie/yaml-front-matter: ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.22.0
- nunomaduro/larastan: ^2.6
- orchestra/testbench: ^8.0
- pestphp/pest: ^2.12
- pestphp/pest-plugin-laravel: ^2.1
- spatie/laravel-ray: ^1.32
README
欢迎使用lara-docs-kit，一个强大的Laravel文档包。此包旨在简化创建和管理Laravel项目文档的过程。
安装
要开始使用lara-docs-kit，请按照以下简单步骤操作
- 使用Composer安装包
composer require rex-devs/lara-docs-kit
- 发布tailwind css文件。
php artisan vendor:publish --tag=lara-docs-kit-assets
- 为了启用语法高亮，需要在项目中安装javascript包shiki。可以通过npm安装。
npm install shiki
- 需要创建一个目录来存储所有文档的markdown文件。使用默认配置，可以使用以下命令创建目录。
mkdir ./resources/docs
- 然后需要在该目录中创建一个
nav.json文件，用于概述导航菜单。
{
"introduction": "/",
}
- 这就完成了！您现在可以使用lara-docs-kit来满足Laravel文档需求。
使用方法
该包默认配置为直接运行，它添加了一个/docs路由，直接从/resources/docs目录中的markdown文件中获取，并交付给公开。但是，有一个配置文件可以发布并按需更改。
配置
使用以下命令发布配置文件
php artisan vendor:publish --tag=lara-docs-kit-config
位于config/lara-docs-kit.php的配置文件可以根据项目需求进行自定义。以下是一个路由示例。
'routes' => [ [ 'name' => 'docs', 'url' => '/docs', 'dir' => 'docs/', 'middleware' => [ 'web', ], ], ],
导航
该包还使用位于包含所有markdown文件的目录顶部的nav.json文件。此文件允许顶级链接以及嵌套链接（最多1级深度）。
{
"introduction": "/",
"parent": {
"introduction": "/parent/",
"child": "/parent/child"
}
}
贡献
如果您发现任何问题或有改进lara-docs-kit的建议，我们欢迎社区贡献。请随时提交拉取请求或创建一个问题。
许可
lara-docs-kit是开源软件，许可协议为MIT许可。
我们希望lara-docs-kit证明是您Laravel项目的宝贵工具。如果您有任何问题或需要帮助，请随时通过justin@rex-devs.co.uk联系我们。
愉快的记录！ 😊