techone/ldoc

Laravel 的文档生成器。

v0.4.0 2019-06-18 04:00 UTC

This package is auto-updated.

Last update: 2024-09-18 19:13:00 UTC


README

Build Status Latest Stable Version Total Downloads License

Ldoc 是一个用于快速生成 PHP 语言的文档的工具。您可以使用 Markdown(或其他语言)编写文档,Ldoc 可以在几秒钟内生成具有美丽主题的文件。

安装

composer require techone/ldoc

config/app.php 中添加 ServiceProvider

'providers' => [
    /*
     * Package Service Providers...
     */
    Ldoc\LdocServiceProvider::class,
]

要发布配置,请运行 vendor publish 命令

php artisan vendor:publish

这将创建一个演示文件在 storage 目录中。

然后,您可以访问 'http://yourdomain.com/docs' 并显示演示。

配置

Ldoc 安装后,您的项目文件夹将看起来如下

默认文档应存储在 storage/docs 目录中

.
├── sidebar.yml
├── version.yml
├── _source
|   ├── index.md
|   └── configuration.md
└── v1
    └── _source
        ├── index.md
        └── configuration.md

许可证

此项目使用Apache 2.0 许可证