rtablada/flat-docs

维护者

详细信息

github.com/rtablada/flatdocs

源代码

问题

安装: 9

依赖: 0

建议者: 0

安全: 0

星标: 3

关注者: 1

分支: 0

公开问题: 0

语言:JavaScript

dev-master 2013-06-13 12:50 UTC

Requires

MIT 66a0a6754985201c7b3a7047b98116c55516ca00

  • Ryan Tablada <ryan.tablada.woop@gmail.com>

This package is not auto-updated.

Last update: 2024-09-23 15:12:59 UTC

README

这个干净的Markdown工具可以让您快速创建出色的文档。

使用 Laravel 4 包安装器 安装

只需运行 php artisan package:install rtablada/flat-docs

使用Composer安装

在您的composer.json中添加 'rtablada/flat-docs': 'dev-master'

然后在您的app/config/app.php中添加以下内容到您的服务提供者 'Rtablada\FlatDocs\FlatDocsServiceProvider',

发布资源和配置

最后运行以下命令

php artisan asset:publish rtablada/flat-docs
php artisan config:publish rtablada/flat-docs

配置

您可以修改配置

创建您的文档

声明文档

通过修改配置文件中的'registeredDocs'属性来注册您希望可用的文档。这将处理URI映射以及创建您的导航！此外，您可以通过使用格式stub:pretty来声明模板与漂亮的标题。顺便说一句，您的uris/文档的深度没有限制！

'registeredDocs' => array(
	'start:Getting Started',
	'api' => array(
		'1:endpoint1',
		'2:endpoint2',
	),
),

Markdown 文件

在您的应用路径中，将您的文档放置在'docs'文件夹中（此位置可以在配置中修改）。它们的顺序应该与您想要的uris的顺序相匹配。因此，示例的文件结构看起来应该是这样的

start.md
api/
	-1.md
	-2.md