天天看點

php markdown 接口文檔生成工具

2017年9月18日 19:20:22 星期一

效果:

php markdown 接口文檔生成工具

碼雲: 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 檔案, 不然, 程式隻會編譯最新修改的檔案

下邊以 小海龜git為例, 給git加hook腳本:

php markdown 接口文檔生成工具