elvisszhang/jr-docs

only one javascript file is need to generate a markdown document system 。只需要一个js文件就能生成漂亮的文档系统。

jrdocs

在线演示

https://elvisszhang.github.io/jr-docs/

项目背景

一直在寻找一个简单易用的文档系统，在我们团队，什么样的文档系统是最适合的呢，我列出了以下要素：

1. 可以浏览器在线浏览
2. 无需配置服务器环境
3. 可以支持多份文档
4. 要有导航树方便查看文档结构
5. 支持多标签功能方便同时查看多个文档
6. 无需编译生成HTML文档

找啊找，先是找到了showdoc这个开源软件，它的优点是可以建立用户和分配权限，可以在线用MARKDOWN语法编辑文档，缺点是需要安装PHP环境，还需要MYSQL数据库的支持，另外文档的展示速度感觉不是太流畅。用了几次还是放弃了。

又有一天突然发现了docute和docsify这两个开源软件，现在好多开源项目都用它们生成帮助文档。它们有一个特色让我特别心动，就是不需要安装PHP环境，也不需要安装数据库，任何支持静态页面的服务器，上传MD格式的文档就能自动生成漂亮的文档页面。可惜有一个缺点就是它主要是针对单个md文件生成帮助系统的，如果需要组织多个md文档的话，不是太好用。

既然市面上暂时没发现适合我们的文档系统，于是就动手开发了现在这个文档系统，以上6个要素都满足了，我们团队足够用了。

到底是不是适合您使用当然就要看您的实际需求了，欢迎反馈任何建议或意见。

开发团队

杭州嘉软科技有限公司，公司官网 http://www.jrtk.net

编译方法

  npm install --registry=https://registry.npm.taobao.org
  npm run build

使用方法 (只需三步)

第一步 搭建WEB服务器 （只要支持静态页面即可）

第二步 配置菜单栏( nav.json文件 )

[
{
	"text":"演示文档",
	"children":[
		{"id":"md/showdown.md","text":"Showdown文档"},
		{"id":"md/flyui.md","text":"FlyUI文档"}
	]
}
]

第三步 上传MD文件到服务器

技术支持

有什么疑问请加官网QQ群32550793咨询。

鸣谢

感谢QQ29170496（深海）提供的table的样式。