安装 doc 插件

在安装的 yii2 根目录下面执行：

composer require --prefer-dist yiisoft/yii2-apidoc

或者在 composer.json 中添加：

"yiisoft/yii2-apidoc": "~2.1.0"

然后执行：composer update

可能会报错，如果报错，将上面的改成：

yiisoft/yii2-apidoc": "~2.0.0"

安装成功就可以使用了

写 md 文件

可以看下面的第四部的路径，md 文件存放的地址：** **/www/yiiframe/doc/yiiframe-guide/cn-1.0，那么我们在这个路径下面新建 2 个比较重要的 md 文件

README.md** 和 **index.md

README.md** **是左侧菜单部分

index.md** **是 guide-index.html 页面，一般和 README.md 一样，用来做首页菜单索引，当然也可以添加自己想要的内容

README.md：

YiiFrame 文档说明
    ===============================
    版权所有。
    2021 (c) YiiFrame Software LLC。
    目前进度
    -----
    *  [YiiFrame 开发进度](yiiframe-jindu.md)
    *  [YiiFrame 开发LOG](yiiframe-jindu-log.md)
    关于与安装
    -----
    *  [YiiFrame 关于-架构特点](yiiframe-about-fecshop.md)
    *  [YiiFrame 关于-功能介绍](yiiframe-about-function.md)
    *  [YiiFrame 关于-系统结构](yiiframe-about-system-contruct.md)
    *  [YiiFrame 安装与初始配置](yiiframe-install.md)
    YiiFrame配置
    -----------
    *  [YiiFrame 配置-配置结构](yiiframe-init-config-construction.md)
    *  [YiiFrame 配置-Yii2配置](yiiframe-init-config-yii2.md)
    *  [YiiFrame 配置-fecshop配置](yiiframe-init-config-advanced.md)

index.md

YiiFrame 文档说明
    ===============================
    版权所有。
    2021(c) YiiFrame Software LLC。
    关于与安装
    -----
    *  [YiiFrame 关于-架构特点](yiiframe-about-fecshop.md)
    *  [YiiFrame 关于-功能介绍](yiiframe-about-function.md)
    *  [YiiFrame 关于-系统结构](yiiframe-about-system-contruct.md)
    *  [YiiFrame 安装-composer](yiiframe-install.md)
    *  [YiiFrame 安装-初始配置](yiiframe-init-config.md)
    功能介绍
    --------
    *  [YiiFrame 功能概叙](yiiframe-feature-summary.md)
    *  [YiiFrame Url自定义](yiiframe-feature-url-custom.md)
    *  [YiiFrame 多语言](yiiframe-feature-mutil-languages.md)

在 README.md 文件里面你可以看到，在括号里面的文件 ，譬如 yiiframe-jindu.md

你需要在** **/www/yiiframe/doc/yiiframe-guide/cn-1.0 下新建括号里面的 md 文件，然后在里面写内容就行了，譬如：

关于 YiiFrame 的框架特点
    =======================
    YiiFrame 是一款优秀的开源框架系统，遵循[OSL3.0协议](http://www.oschina.net/question/28_8527)，
  1. 写个 sh 脚本用来生成文档，当然，您可以可以直接运行里面的代码，不过用 sh 运行比较方便：

#!/bin/sh

rm -rf ~/www/yiiframe/doc/html/*
~/www/yiiframe/vendor/bin/apidoc guide ~/www/yiiframe/doc ~/www/yiiframe/doc/html/ –interactive=0

md 文件存放的地址为：** **/www/yiiframe/doc/yiiframe-guide/cn-1.0

md 生成的 html 的地址为：/www/yiiframe/doc/yiiframe-guide/cn-1.0/

然后 nginx 指向** **/www/yiiframe/doc/yiiframe-guide/cn-1.0/

然后访问** **http://127.0.0.1/guide-index.html

就可以看到效果了

最后，您可能感觉样式不好，想改一下，可以修改；

vendor/bower/bootstrap/dist/css/bootstrap.css

或者添加文件，覆盖这个文件里面的 css 内容即可。

如果您要大改，把页面底部彻底换掉，可以到

/www/web/tadoc/vendor/yiisoft/yii2-apidoc/templates

这里找对应的代码，然后改掉 html 内容，在添加 css 内容等等

声明：本站所有文章，如无特殊说明或标注，均为本站原创发布。任何个人或组织，在未征得本站同意时，禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益，可联系我们进行处理。