# PHP-Markdown 接口文档管理工具

**Repository Path**: ydg/PHP-Markdown

## Basic Information

- **Project Name**: PHP-Markdown 接口文档管理工具
- **Description**: 简单的MarkdownApi管理工具:
左侧目录树: dtree.js
Markdown转html: segmentfault社区开发的工具
遍历md源文件夹: 自己写的利用后根序遍历算法读取文件夹PHP工具
- **Primary Language**: PHP
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 21
- **Created**: 2019-05-04
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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