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

有没有比 docusaurus 好看的文档生成工具

  •  
  •   laravel · Oct 7, 2022 · 6285 views
    This topic created in 1505 days ago, the information mentioned may be changed or developed.

    我想写教程,类似 runoob 、w3school 那种,左边是列表,右边是内容。

    只想用 markdown 写教程,不想改代码。

    20 replies  •  2022-10-08 13:50:45 +08:00
    Hansah
    Hansah
    Oct 7, 2022
    1
    你又要好看,又不想改代码,只能找找好看的主题了
    malagebidi
    malagebidi
    Oct 7, 2022
    2
    docusaurus 的打印效果比较好,这个我对比过
    kongkx
    kongkx
    Oct 7, 2022 via iPhone
    3
    好看的定义是? 有参照对象? 要不在 docusaurus 的 showcase 里面找个喜欢的,扒一下主题代码?
    lavard
    lavard
    Oct 7, 2022❤️1
    4
    最近比较火的 Astro ? 性能爆炸 但是比较新, 社区模板主题啥的还比较少
    lavard
    lavard
    Oct 7, 2022
    5
    或者 VitePress 也是不错的,Vue 周边生态都是用 VitePress 搭的,挺好看的。比如 Vue 官网,Vite, Pinia, Vitest.
    如果 docusaurus 支持 Vite 就更好了,webpack 在内容多的时候热更新的速度还是让人非常不满意
    LindsayZhou
    LindsayZhou
    Oct 7, 2022
    6
    https://squidfunk.github.io/mkdocs-material/
    我看到很多 Python 开源库的文档都是用的这个。
    Hsins
    Hsins
    Oct 7, 2022
    7
    @lavard 性能爆炸是爆炸高還是爆炸低?
    lavard
    lavard
    Oct 7, 2022❤️1
    8
    @Hsins 那肯定是高啊。 因为采用 Islands Architecture (孤岛架构), 几乎没有 JS 代码, 而且支持各大前端框架,Vue ,React, Angular , Solid ... 。
    我用 lighthouse 测 , 清一色 100 分,离谱的很, 我本来博客也是 docusaurus 搭的,也尝试过 VitePres , 很喜欢 Vite 的开发体验, 但是 VitePress 很多方案社区还没有,比如 i18 国际化,在线沙盒..etc, 然后就一直找到了 Astro ,支持任意前端框架 + Vite 。( Astro 团队 之前开发过 SnowPack , 干不过 Vite 所以用 Vite 了)
    laravel
    laravel
    OP
    Oct 7, 2022
    9
    这次用 vuepress 试试吧
    laravel
    laravel
    OP
    Oct 7, 2022
    10
    vitepress 的 hello world 真干净,剧情开头很吸引人。

    https://raw.githubusercontent.com/tennessine/v2ex-images/main/QQ20221007-184156%402x.png
    zhoujinjing09
    zhoujinjing09
    Oct 7, 2022
    11
    VitePress 或者 mkdocs

    docusaurus 审美落后了,但是 VitePress 很多功能现在还没有
    laravel
    laravel
    OP
    Oct 7, 2022❤️1
    12
    哎,我还是美化下 docusaurus 吧,感觉都差不多,没必要换一个,我以前用 docusaurus
    yufeng0681
    yufeng0681
    Oct 7, 2022
    13
    obsidian ,写完发布到 obsidian 的网站上(收费)
    或者找开源的发布成 html ,自己弄个网站加载起来
    azraeljack
    azraeljack
    Oct 7, 2022
    14
    之前公司的文档库是用 dumi 搭的,感觉还行
    dayeye2006199
    dayeye2006199
    Oct 8, 2022
    15
    教程的核心难道不是里面的内容么。。

    排版啥的干净方便查询不就可以了。。
    loading
    loading
    Oct 8, 2022
    16
    目前我在用 docsify 。

    https://docs.keeb.pro/#/
    lyhiving
    lyhiving
    Oct 8, 2022
    17
    @lavard 看了下 Astro ,确实是一股清流。
    Envov
    Envov
    Oct 8, 2022
    18
    如果只有 markdown 的话,可以自己写脚本扫一下文件目录,生成网站,样式啥的不是随便弄吗
    Deteriorator
    Deteriorator
    Oct 8, 2022
    19
    我用的是 rst 文档, 用 sphinx 生成的文档也方便
    ada87
    ada87
    Oct 8, 2022 via Android
    20
    mkdocs
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Privacy   ·   Solana   ·   2738 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 62ms · UTC 10:19 · PVG 18:19 · LAX 02:19 · JFK 05:19
    ♥ Do have faith in what you're doing.