V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
Daring Fireball: Markdown
CommonMark
MacDown Open Source Markdown Editor
Marked
GitHub Flavored Markdown
elvisszhang
V2EX  ›  Markdown

超级简单易用的 MarkDown 文档帮助系统

  •  
  •   elvisszhang · 2017-03-19 18:28:38 +08:00 · 8120 次点击
    这是一个创建于 2566 天前的主题,其中的信息可能已经有所发展或是发生改变。

    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

    使用方法 (只需三步)

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

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

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

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

    技术支持

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

    7 条回复    2020-12-17 11:36:17 +08:00
    cyio
        1
    cyio  
       2017-03-19 18:57:31 +08:00
    能方便地在本地测试吗,比如我本地有个包含 md 的目录,启动服务在浏览器查看
    qinc
        2
    qinc  
       2017-03-20 09:27:36 +08:00
    好像不支持搜索。要支持就完美了
    skinfiter
        3
    skinfiter  
       2017-03-20 10:11:03 +08:00
    感觉 hexo 就满足需求了呀
    franklinyu
        4
    franklinyu  
       2017-03-21 01:08:14 +08:00
    @skinfiter Hexo 寫完還得 hexo generate 一下,他大概是希望 JavaScript 直接去抓取 Markdown 然後渲染吧
    skinfiter
        5
    skinfiter  
       2017-03-21 09:12:43 +08:00
    @franklinyu watch 一下文件不是很好?
    franklinyu
        6
    franklinyu  
       2017-04-02 13:05:02 +08:00
    @skinfiter 你是问我为啥他有这奇葩的需求?这你得问楼主呀
    saywujian
        7
    saywujian  
       2020-12-17 11:36:17 +08:00
    推荐使用 Baklib 在线帮助文档 /知识库制作工具,更简单效果更好。
    d5wz.cn/ugxy
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   1089 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 27ms · UTC 22:47 · PVG 06:47 · LAX 15:47 · JFK 18:47
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.