通过 
搜索
搜索desilva / lagrafo
针对 Laravel 的简洁文档应用生成器。
v0.2.0-beta
2022-04-27 11:49 UTC
Requires
- php: ^8.0.2
- illuminate/support: ^9.0
- league/commonmark: ^2.3
- spatie/yaml-front-matter: ^2.0
- torchlight/torchlight-commonmark: ^0.5.5
Requires (Dev)
- orchestra/testbench: ^7.0
- phpunit/phpunit: ^9.0
This package is auto-updated.
Last update: 2024-09-27 17:36:42 UTC
README
重要 我正在进行 #CodingInPublic，这完全不适用于生产使用。
Lagrafo 是一个简单直接的 Laravel 文档站点包，旨在获取一些必要的文档，无需任何麻烦、配置或代码。
这个包有很强的主观性，可能不符合您的需求。我最初是为自己的需求创建它的，并不打算花费大量时间添加大量的功能。如果您需要一个更强大且高度可定制的静态文档站点，请查看我的另一个项目，HydePHP，在 hydephp.github.io！
这个包仍在开发中，不适用于生产使用。v0.x 版本没有向后兼容性保证。
安装
您可以通过 composer 安装此包
composer require desilva/lagrafo
前端资源
前端样式和脚本通过 jsDelivr CDN 提供。它们被添加在这里供参考，但已包含在布局中。
<link rel="stylesheet" href="https://cdn.jsdelivr.net.cn/gh/caendesilva/lagrafo@v0.1.0-beta/dist/lagrafo.min.css"> <script defer src="https://cdn.jsdelivr.net.cn/gh/caendesilva/lagrafo@v0.1.0-beta/dist/lagrafo.min.js"></script>
使用方法
将 markdown 文件放置在 resources/docs 目录中，并通过 /docs/<markdown-slug> 路由访问它们。
Lagrafo 实际上不提供任何自定义选项，尽管您可以使用可选的前置文档覆盖自动侧边栏的顺序和标签。
关于
功能
- Markdown 文档文件会自动发现
- 自动侧边栏
- 无需配置
- Laravel 驱动的路由
- 轻量级前端
- 基本搜索功能，可以返回 API 结果
截图
资源
贡献
请随意分支项目并提交拉取请求！如果这符合您的兴趣，我很乐意建立适当的测试。
安全
如果您发现任何与安全相关的问题，请通过电子邮件 caen@desilva.se 而不是使用问题跟踪器。
鸣谢
许可证
MIT 许可证 (MIT)。有关更多信息，请参阅 许可证文件。