返利网前端文档

链接:https://fanlife.github.io/docs/

使用

本文档采用gitbook构建,如需对文档进行维护,首先需要安装全局gitbook

npm install gitbook -g

对文档维护过程中仅需要对.md文件进行操作,因此需熟悉markdown语法,并选择合适的支持markdown语法的编辑器。

新增目录及文件

  • 无论是新增目录还是文件,都只需要在SUMMARY.md中添加对应目录/文件,例:
* [返利网前端文档](README.MD)
    * [fvmu](fvmu/README.MD)
        * [plugins](fvmu/plugins/README.md)
            * [Toast](fvmu/plugins/toast.md)
            * [Dialog](fvmu/plugins/dialog.md)

以上语法会生成四级目录,并生成5个md文件,如需添加对应目录或文件,直接修改SUMMARY.md即可。

  • 修改SUMMARY.md后,执行gitbook init命令即可自动生成对应目录及相应文件夹
  • 对应文档编辑完成后,直接提交push即可,请不要本地构建,本仓库集成了travis-ci(持续集成工具),push操作会触发travis-ci的部署脚本,travis-ci会自动执行gitbook build并将生成的代码拷贝并提交到fanlife.github.io仓库

results matching ""

    No results matching ""