V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
MuscleOf2016
V2EX  ›  程序员

静态文档站点推荐

  •  
  •   MuscleOf2016 · 172 天前 · 3272 次点击
    这是一个创建于 172 天前的主题,其中的信息可能已经有所发展或是发生改变。

    需求如下: 1 、内置内容搜索索引,方便全文档搜索 2 、最好能支持主题切换,或者换模版。 3 、打包静态资源部署,不用 wordpress

    之前用的 docusaurus 做的文档站点,今天突然看到了 Rspress 好像还不错,内置了搜索索引。 有用过的朋友吗,Rspress 具体怎么样?

    23 条回复    2024-01-27 13:51:45 +08:00
    sigoden
        1
    sigoden  
       172 天前   ❤️ 1
    mdbook 完美满足你的需求。
    BORBER
        2
    BORBER  
       172 天前
    Rspress 还行, 有浅浅试用一下, 搜索也不错 这是我试用的站点 https://tran.borber.top
    opengps
        3
    opengps  
       172 天前
    我当时自己做了一个,但是苦于前端太丑,就搁置了
    qloog
        4
    qloog  
       172 天前
    docusaurus 感觉够用,搜索可以配合:Algolia DocSearch(专做搜索的)
    试用站点: https://go-eagle.org/
    MuscleOf2016
        5
    MuscleOf2016  
    OP
       172 天前
    @qloog 没办法,内网用的,不能传到外网。
    shuxhan
        6
    shuxhan  
       172 天前
    除了切换模板主题,我觉得 vitepress 可以满足你,内置高亮和黑夜主题,其他就需要自己定制了。
    MENGKE
        7
    MENGKE  
       172 天前
    vitepress
    hemingway
        8
    hemingway  
       172 天前   ❤️ 1
    docsify 我用的这个,非常不错
    musi
        9
    musi  
       172 天前
    自己用 vite + rehype + meilisearch 写一个,rehype 可以将 md 解析成 ast ,你甚至可以自定义语法或者变量,最后输出成 vue template 交给 vite 编译,meilisearch 用于搜索,这套方案你甚至可以直接把 md 的 ast 解析成合适的数据喂给 langchain ,这样搜索+AI 都有了。至于换模版,这就是个 vue 项目,你想怎么定义怎么定义,我是用 tailwindcss + typography 插件
    shimada666
        10
    shimada666  
       172 天前
    vitepress ,如果有自动侧边栏需求可以用 https://github.com/QC2168/vite-plugin-vitepress-auto-sidebar 插件
    Moatkon
        11
    Moatkon  
       172 天前
    https://starlight.astro.build/zh-cn/ 我的站点就是用这个构建的
    smallyu
        12
    smallyu  
       172 天前
    有没有人用 jb 家的 Writeside
    hongchends1
        13
    hongchends1  
       172 天前
    我用的 mkdocs 还有 wiki.js
    stevenshum
        14
    stevenshum  
       172 天前   ❤️ 1
    @hongchends1 mkdocs-material +1 ,很好很强大
    stevenshum
        15
    stevenshum  
       172 天前
    @stevenshum https://weiyan.cc/ ,我的站点用的就是 mkdocs-material
    zsh2517
        16
    zsh2517  
       172 天前   ❤️ 2
    docusaurus 、rspress 等有一个关键词:SSG (静态站点生成器),可以靠这个去搜索更多的内容

    ---

    rspress 没用过,不过我之前某个东西需要一份 API 文档,对比了 docsify, vitepress 和 docusaurus. 最终选择了 vitepress 。

    大概考虑的理由

    docsify: SSR 前端渲染(前端拉取 markdown 源文件)。部署最简单(甚至不需要构建),但是有点简陋。而且不如 SSG 的体验好。
    vitepress 、docusaurus:功能很丰富,一个 vue 生态,一个 react 生态,需要的功能基本都有。

    选择 vitepress 没有选择 docusaurus 的原因

    1. docusaurus 拼写记不住,读也没法通过字面看出来。
    2. docusaurus 有点过于庞大,而且对项目侵入比较高,一般适合单独开一个 repo ,而不是使用 docs/ 目录这种形式
    3. webpack 预览比较慢
    4. 我更喜欢 vitepress 的样式

    关于搜索

    vitepress 支持本地搜索(构建的时候生成索引),但是分词目前我没找到特别好的方案。默认配置不太适合中文,目前我是直接拆开文字一个字符一个字符划分的 token
    liuliancao
        17
    liuliancao  
       172 天前
    我在用 可能没那么好看 但是还不错 docsify
    Pters
        18
    Pters  
       172 天前
    语雀
    xiaojun996
        19
    xiaojun996  
       172 天前
    我用 vitepress
    matthewzhong
        20
    matthewzhong  
       172 天前
    推荐 hugo ,我的博客:[码中人的博客]( https://blog.mzh.ren/zh/)
    Shiroka
        21
    Shiroka  
       172 天前
    推荐 nextra-docs ,1 3 都可以,不知道自动切换暗黑能不能勉强满足 2

    https://github.com/shuding/nextra-docs-template

    https://nextra-docs-template.vercel.app/
    karott7
        22
    karott7  
       171 天前
    推荐 vitepress
    thawne
        23
    thawne  
       141 天前
    vitepress + 1
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1771 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 33ms · UTC 16:30 · PVG 00:30 · LAX 09:30 · JFK 12:30
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.