V2EX = way to explore
V2EX 是一个关于分享和探索的地方
Sign Up Now
For Existing Member  Sign In
爱意满满的作品展示区。
sox

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

  •  
  •   sox ·
    egoist · Dec 10, 2016 · 7719 views
    This topic created in 3437 days ago, the information mentioned may be changed or developed.

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

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

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


    灵感源自 docpress 和 https://study.congcong.us/t/323516 cc @qingv

    preview

    7 replies    2016-12-12 11:41:26 +08:00
    airyland
        1
    airyland  
       Dec 10, 2016
    貌似和 docsify 没什么不同?
    qingv
        2
    qingv  
       Dec 11, 2016 via iPhone
    支持
    InFaNg
        3
    InFaNg  
       Dec 11, 2016 via Android
    滋瓷
    sox
        4
    sox  
    OP
       Dec 12, 2016
    @airyland UI 上有些不同,比如侧边栏 toc 的功能更接近 vuejs.org ,以及支持 front-matter 等等
    airyland
        5
    airyland  
       Dec 12, 2016
    @sox 侧栏的样式确定比较合理, docsify 的颜色有点太浅了。另外 8080 端口太常见了,建议换个默认端口,或者可以配置。
    sox
        6
    sox  
    OP
       Dec 12, 2016 via Android
    @airyland 可以设置的 --port
    visionsmile
        7
    visionsmile  
       Dec 12, 2016
    great,已 star
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   1330 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 693ms · UTC 17:31 · PVG 01:31 · LAX 10:31 · JFK 13:31
    ♥ Do have faith in what you're doing.