V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
sox
V2EX  ›  分享创造

docute - 无需编译的文档生成器,使用 markdown 格式撰写

  •  
  •   sox ·
    egoist · 2016-12-10 22:17:55 +08:00 · 7156 次点击
    这是一个创建于 2916 天前的主题,其中的信息可能已经有所发展或是发生改变。

    一般的文档网站会选择使用 gitbook 或者 hexo 之类的静态博客生成器构建,但它们都需要把 markdown 文件编译成静态的 html 文件, docute 可以省去这一步,因为它在你访问的时候才请求相关文档然后解析为 html 展现出来。

    比如 github pages 支持从 ./docs 目录部署网站,那么在你访问首页的时候它就请求 ./README.md 然后渲染出来。这样你的 repo 里就不会有一堆编译生成的文件了。只需要 push 然后即刻生效。

    docute 的文档就是由 docute 支持的: https://docute.js.org


    灵感源自 docpress 和 https://www.v2ex.com/t/323516 cc @qingv

    preview

    7 条回复    2016-12-12 11:41:26 +08:00
    airyland
        1
    airyland  
       2016-12-10 22:46:10 +08:00
    貌似和 docsify 没什么不同?
    qingv
        2
    qingv  
       2016-12-11 05:56:11 +08:00 via iPhone
    支持
    InFaNg
        3
    InFaNg  
       2016-12-11 18:38:55 +08:00 via Android
    滋瓷
    sox
        4
    sox  
    OP
       2016-12-12 00:08:11 +08:00
    @airyland UI 上有些不同,比如侧边栏 toc 的功能更接近 vuejs.org ,以及支持 front-matter 等等
    airyland
        5
    airyland  
       2016-12-12 10:48:41 +08:00
    @sox 侧栏的样式确定比较合理, docsify 的颜色有点太浅了。另外 8080 端口太常见了,建议换个默认端口,或者可以配置。
    sox
        6
    sox  
    OP
       2016-12-12 11:05:34 +08:00 via Android
    @airyland 可以设置的 --port
    visionsmile
        7
    visionsmile  
       2016-12-12 11:41:26 +08:00
    great,已 star
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1035 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 23ms · UTC 19:58 · PVG 03:58 · LAX 11:58 · JFK 14:58
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.