Markdown 文档

2022年11月10日 14:34 小于 1 分钟

# Markdown 文档

# 1、创建md文件

根目录下创建docs(你也可以是别的)目录,并创建md文档文件,如下

app
config
docs
 |—— Use.md
 |—— admin
    |—— HttpStatus.md
    |—— HttpCode.md
 |—— demo
    |—— HttpStatus.md
    |—— HttpCode_v1.md 
    |—— HttpCode_v2.md
 ...
1
2
3
4
5
6
7
8
9
10
11
12

# 2、配置文档菜单

可使用 ${app[N].folder} 做多版本区分,变量参数用法见配置说明

// config/apidoc.php
<?php
return [
    // markdown 文档
    'docs' => [
        ['title'=>'lang(apidoc.doc.about)','path'=>'docs/readme'],
        ['title'=>'md语法示例','path'=>'docs/Use'],
        ['title'=>'md Test','path'=>'docs/test'],
        [
            'title'=>'HTTP响应编码',
            'children'=>[
                ['title'=>'status错误码说明','path'=>'docs/HttpStatus'],
                ['title'=>'code错误码说明','path'=>'docs/HttpCode_${app[0].folder}_${app[1].folder}'],
            ],
        ]
    ],
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

apidoc-demo-md