1 Star 0 Fork 20

hahan2020 / Summer-PHP-Markdown

forked from myDcool / PHP-Markdown-Doc 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

接口文档管理工具

案例

SummerPHP框架说明文档

简单的MarkdownApi管理工具:

  • Markdown转html: parsedown(无安全校验速度快)
  • 遍历md源文件夹: 用PHP实现的利用后根序遍历算法读取文件夹内所有文件的工具类(tool/Dir.php)
  • 左侧目录树: 用PHP实现的生成HTML代码的工具类(tool/Html.php)

用法:

  • 将md文件放进src文件中, 其文件和目录的命名就是最终生成树型目录中的名字
  • 将目录或文件名前加上前缀用来按顺序显示目录, 前缀格式为: _\d+_, 例如 _01_xxx.md. 最终目录中不会有此前缀
  • 用PHP解释程序执行 compile.php 文件 (windows下建议用php7+: path/to/php.exe compile.php), 这一步会将md文件解析成html文件, 放到_book目录里
  • Nginx/Apache 服务器
    • 建一个虚拟机 (例如:doc.hearu.top)
    • 将虚拟机的根目录指向_book
    • 虚拟机的入口文件设置为index.html
    • 启动服务器, 在浏览器里访问 doc.hearu.top 就可以了 (本地搭建需要修改hosts文件)

小技巧:

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

说明:

  • 程序每次编译都会把编译时间记录下来, 下次编译的时候如果该文件没有修改, 就不会再编译了, 删掉记录时间用的那个文件(last_compile_time.log)就可以全部重新编译了
  • 600多个markdown文件秒杀, 效率很高
  • 总结
The MIT License (MIT) Copyright (c) 2018 myDcool Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

简单的markdown文档管理工具, 自动创建目录, 可指定顺序 展开 收起
PHP
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
PHP
1
https://gitee.com/hahan2020/PHP-Markdown.git
git@gitee.com:hahan2020/PHP-Markdown.git
hahan2020
PHP-Markdown
Summer-PHP-Markdown
master

搜索帮助