搭建markdown文档系统
FKPJS
的技能之一,快速整理一套基于markdown的教程文档
开源项目的文档系统及内部API文档好帮手
简单用法
将md文件放置在相应的目录,/demoindex
将自动完成文档列表,及文档详情
兼容经典markdown语法,自定义语法支持(另开一文),纯静态生成,配合git,一套wiki ok!
现在的样式不是很满意,本人设计水平有限,如果有朋友能够提供设计帮助,不胜感激,请发我邮箱kixi@163.com
,呵呵
md文件放置说明图:(图一)
效果如下图: (图二)
对比图一与图二,目录会转成菜单项,而文件会自动生成html,是不是很简单
特殊文件
图一
中有一个特殊文件index.md
,他的内容将呈现在这里,如下图: