dalencar/yii2-slate

Slate 与 yii2 的集成。

维护者

详细信息

github.com/davidsonalencar/yii2-slate

源代码

问题

安装次数: 119

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 1

公开问题: 0

语言：JavaScript

0.1.0 2017-08-10 12:49 UTC

Requires

MIT 126285fac1fa33088578e63a4f1b5f643dee993f

  • Davidson Alencar <davidson.t.i.woop@gmail.com>

restfulextensiondocumentyii2slate

This package is not auto-updated.

Last update: 2024-09-20 20:16:12 UTC

README

#Yii2 Slate 控制器

关于

本项目通过控制器以动态方式构建 Markdown 文件，生成 Slate 文档。

您不需要在构建之前创建 slate 文档。这是在运行时完成的。

建议：使用 pahanini/yii2-rest-doc 来动态生成您的 Markdown 文件。

安装

  • 将 "dalencar/yii2-slate": "*" 添加到您的 composer.json 文件中所需的部分
  • 在您的控制器中添加一个动作。例如，名为 api 的动作的 DocController
public function actions()
{
    return [
        'api' => [
            'class' => 'dalencar\slate\SlateAction',
            'sourceBase' => '@backend/views/doc/api',
            'configFile' => '@backend/views/doc/api/config.json',
        ],
    ];
}
  • 复制 Slate 模板

将 vendor/dalencar/yii2-slate/view 中的所有文件和文件夹复制到您的控制器动作文件夹中，例如 views/doc/api。

/fonts
/images
/includes
/javascripts
/stylesheets
apis.md [will be created dynamically]
authentication.md
introduction.md
config.json
  • 设置 config.json 文件
{
    "title": "API Reference",
    "language_tabs": ["bash", "javascript"],
    "toc_footers": [],
    "search": true,
    "menu": [
        "introduction",
        "authentication",
        "apis"
    ],
    "menu_includes": [
        "errors"
    ],
    "custom": {
        "BASE_URL": "http://localhost"
    }
}