• 请不要在回答技术问题时复制粘贴 AI 生成的内容
JJstyle
V2EX  ›  程序员

目前文档是用 gitbook 写的, 200 多个页面, build 一次太慢了,请问有什么好的替代方案?

  •  
  •   JJstyle · Sep 8, 2020 · 6973 views
    This topic created in 2254 days ago, the information mentioned may be changed or developed.

    目前 build 一次需要 100 多秒,有点无法接受,请问有什么好的替代方案? 要求:

    1. 不能破坏当前的目录结构,可复用 SUMMARY.md 当做菜单或者目录
    2. 能生成 PDF 文档(带有封面 /目录,非单个 md 文件生成)
    Supplement 1  ·  Sep 8, 2020

    Summary.md 是 gitbook 用于配置目录和菜单用的,举个例子:

    # Summary
    
    * [主页](README.md)
    * [最近更新](latest-updated.md)
    
    ---
    
    * [后端开发](backend/README.md)
        * [v3.9加值券部署指南](backend/README-v3.9-coupon.md)
        * [抢红包并发模拟](backend/coupon-concurrency.md)
        * [MySQL部分字段解释](backend/mysql-field-types.md)
        * [datetime字段转timestamp](backend/db-datetime-2-timestamp.md)
        * [phpstorm使用技巧](backend/phpstorm.md)
        * [消息-在线推离线拉模式](backend/message-push-pull.md)
    
    Supplement 2  ·  Sep 9, 2020
    1. 公司内部文档,所以不接受用任何托管服务;
    2. 有时候需要将部分文档生成 PDF (多页生成,包含目录和封面)给第三方。

    目前 gitbook cli 能用,就是太慢了。
    28 replies  •  2020-09-09 23:15:45 +08:00
    755rQlBW742S6Fcc
    755rQlBW742S6Fcc
    Sep 8, 2020
    1
    vuepress
    96412hj
    96412hj
    Sep 8, 2020
    2
    jira confluence google doc 都可以呀
    JJstyle
    JJstyle
    OP
    Sep 8, 2020
    3
    @qingjiaowochangd vuepress 看着不错,可以根据目录自动生成菜单吗?或者根据 SUMMARY.md 生成也行,我看需要在 js 文件中配置,似乎比较麻烦😂,我这 200 多个页面分 10 几个目录
    sidkang
    sidkang
    Sep 8, 2020
    4
    docify,summary 稍微改改应该就可以直接用了
    sidkang
    sidkang
    Sep 8, 2020
    5
    docsify 更正
    afc163
    afc163
    Sep 8, 2020❤️1
    6
    dumi - 基于 Umi 、为组件开发场景而生的文档工具: https://d.umijs.org/
    Cbdy
    Cbdy
    Sep 8, 2020 via Android
    7
    换语雀,支持导入 markdown
    matrix67
    matrix67
    Sep 8, 2020
    8
    mdbook 直接可以用的。rust 写的
    matrix67
    matrix67
    Sep 8, 2020❤️4
    9
    gitbook 里面明显用了油漆匠算法。


    ================
    老王得到一份当街道油漆匠的工作,工作内容是在马路中间喷涂点画线。第一天, 他拿出一罐漆来到他负责的路段,喷涂了 300 码长的线。“干得不错! ”他的老板称赞道, “真是一位麻利的工匠”,然后赏给他一个戈比(一种俄罗斯辅币,译者注)。

    第二天,老王只喷涂了 150 码。“喏,虽然不如昨天那样好,但你仍然算得上一位 麻利的工匠! 150 码还是值得肯定的一个长度,”老板说完又赏给他一戈比。

    接下来的一天,老王只喷涂了 30 码长的马路。“才 30 码!”他的老板吼道。“这太 令人难以接受了!第一天你干的工作量是今天的 10 倍!接下来是怎么回事?〃

    “我尽力了,”老王说道。“一天一天下去,我离油漆罐越来越远!〃
    matrix67
    matrix67
    Sep 8, 2020
    10
    而且 https://news.ycombinator.com/item?id=23659451 这边也有一个大佬抱怨过。

    It became clear to me that, internally some sort of scaling problem is present in the code that manifests itself abruptly once the book hits a certain size.
    bless110
    bless110
    Sep 8, 2020
    11
    我之前也用的 gitbook,然后改用的 docsify.js ,迁移比较顺利。你可以参考下 https://github.com/zhaohaodang/pro-js
    jorneyr
    jorneyr
    Sep 8, 2020
    12
    我就是把 Gitbook 的改为了 Docsify,很容易
    zhbzhbzhbz
    zhbzhbzhbz
    Sep 8, 2020
    13
    docsify
    yuhangch
    yuhangch
    Sep 8, 2020 via iPhone
    14
    docsify,理论上稍微改改目录就可以了
    itskingname
    itskingname
    Sep 8, 2020
    15
    @matrix67 为什么不带着油漆桶走呢
    matrix67
    matrix67
    Sep 8, 2020
    16
    @itskingname #15

    所以才叫油漆匠算法啊。 你的算法是不能随着问题的规模 scale 的。

    比如 gitbook 渲染 10 个页面要 10 秒; 但是加一个页面,不是多花 1 秒,是多花 11 秒哦,他就是从头吭哧吭哧渲染起的油漆匠啊。

    755rQlBW742S6Fcc
    755rQlBW742S6Fcc
    Sep 8, 2020
    17
    @JJstyle 你用代码改下这个文件 修改成 vuepress 的 config 就行了
    dnL
    dnL
    Sep 8, 2020
    18
    @itskingname 我说我杀人不眨眼,你问我眼睛干不干?
    itskingname
    itskingname
    Sep 8, 2020 via iPhone
    19
    @matrix67 明白了,感谢
    anUglyDog
    anUglyDog
    Sep 8, 2020
    20
    mlboy
    mlboy
    Sep 9, 2020 via iPhone
    21
    不如换台新电脑?
    raaaaaar
    raaaaaar
    Sep 9, 2020 via Android
    22
    没人用 mdbook ?模仿 gitbook 的,但编译速度快许多。
    12101111
    12101111
    Sep 9, 2020
    23
    @raaaaaar 楼主要输出到 pdf,现在 mdbook 好像没有支持生成 pdf 书签的后端
    aiifabbf
    aiifabbf
    Sep 9, 2020
    24
    sphinx <sphinx-doc.org/> 可以输出到各种格式( LaTeX, html, man page ),好像 Python 和 Swift 的官方文档都是用这个生成的。
    SpiritLingPub
    SpiritLingPub
    Sep 9, 2020
    25
    我觉得你直接用看云吧,看云和 gitbook 很相似的,都是 summary 来设置目录,而且看云也是 git 管理的。
    JCZ2MkKb5S8ZX9pq
    JCZ2MkKb5S8ZX9pq
    Sep 9, 2020 via iPhone
    26
    0703wzq
    0703wzq
    Sep 9, 2020
    27
    docsify 无需编译。
    solider245
    solider245
    Sep 9, 2020
    28
    我想知道 docsify 如何自动生成目录呢?文件少还好,多了的话,每篇文章都要写一个目录,扛不住啊
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Privacy   ·   Solana   ·   2284 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 60ms · UTC 13:45 · PVG 21:45 · LAX 05:45 · JFK 08:45
    ♥ Do have faith in what you're doing.