1 Star 0 Fork 20

yc8332 / PHP-Markdown 接口文档管理工具

forked from myDcool / PHP-Markdown-Doc 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
该仓库未声明开源许可证文件(LICENSE),使用请关注具体项目描述及其代码上游依赖。
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README

PHP-Markdown 接口文档管理工具

简单的MarkdownApi管理工具:

  • 左侧目录树: dtree.js (2004, 无依赖)
  • Markdown转html: Segmentfault社区开发的PHP类
  • 遍历md源文件夹: 自己实现的利用后根序遍历算法读取文件夹内所有文件的PHP工具

用法:

  • 将md文件放进src文件中, 其文件和目录的命名就是最终生成树中的名字
  • 用PHP解释程序执行 compile.php 文件 (windows: path/to/php.exe compile.php), 这一步会将md文件解析成html文件, 放到_book目录里
  • Nginx/Apache 服务器
    • 建一个虚拟机 (www.doc.com)
    • 虚拟机的入口文件设置为index.html
    • 将_book里的文件放到虚拟机指向的根目录下
    • 启动服务器, 在浏览器里访问 www.doc.com 就可以了

注:

  • 给git 加一个post-push hook, 可以将_book作为git仓库, 提交(push)后自动部署到服务器根目录下
  • 给git 加一个pre-commit hook, 将执行PHP编译md文件的命令放在 提交前 的时候执行, 这样就不用每次都手动执行编译命令了
  • code, table 的样式(github风格)已经写好了, 在 _book/dtree/my.css

空文件

简介

简单的MarkdownApi管理工具: 左侧目录树: dtree.js Markdown转html: segmentfault社区开发的工具 遍历md源文件夹: 自己写的利用后根序遍历算法读取文件夹PHP工具 展开 收起
PHP
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
PHP
1
https://gitee.com/yc8332/PHP-Markdown.git
git@gitee.com:yc8332/PHP-Markdown.git
yc8332
PHP-Markdown
PHP-Markdown 接口文档管理工具
master

搜索帮助