php markdown 接口文档生成工具
Posted
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了php markdown 接口文档生成工具相关的知识,希望对你有一定的参考价值。
2017年9月18日 19:20:22 星期一
效果:
码云: https://gitee.com/myDcool/php-Markdown.git
说明:
简单的MarkdownApi管理工具:
左侧目录树: dtree.js
Markdown转html: segmentfault社区开发的PHP工具
遍历md源文件夹: 自己写的利用后根序遍历算法读取文件夹PHP工具
使用说明:
1. 需要安装 PHP 最好是7环境
2. 将md文件放入src目录里, 按照自己的项目命名文件和文件夹(这些名字就是最终生成的api树形目录的名字)
3. 进入根目录, 运行命令: php compile.php 之后就可以在_book目录里看到编译好的html文件了
注意, _book里的dtree目录是事先写好的css和js, 对dtree的源文件有一些简单的改动, 如果不小心删掉了, 可以到根目录里解压dtree.zip, 复制到_book文件夹中
如果想重新编译所有文件, 可以删掉根目录下的 last_compile_time.log 文件, 不然, 程序只会编译最新修改的文件
以上是关于php markdown 接口文档生成工具的主要内容,如果未能解决你的问题,请参考以下文章
MarkdownPad目录生成工具,让你的Markdown文档更方便查看
扔掉Swagger,试试这款功能强大,零注解侵入的API接口文档生成工具!