静态文档站点推荐

133 天前
 MuscleOf2016

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

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

3151 次点击
所在节点    程序员
23 条回复
sigoden
133 天前
mdbook 完美满足你的需求。
BORBER
133 天前
Rspress 还行, 有浅浅试用一下, 搜索也不错 这是我试用的站点 https://tran.borber.top
opengps
133 天前
我当时自己做了一个,但是苦于前端太丑,就搁置了
qloog
133 天前
docusaurus 感觉够用,搜索可以配合:Algolia DocSearch(专做搜索的)
试用站点: https://go-eagle.org/
MuscleOf2016
133 天前
@qloog 没办法,内网用的,不能传到外网。
shuxhan
133 天前
除了切换模板主题,我觉得 vitepress 可以满足你,内置高亮和黑夜主题,其他就需要自己定制了。
MENGKE
133 天前
vitepress
hemingway
133 天前
docsify 我用的这个,非常不错
musi
133 天前
自己用 vite + rehype + meilisearch 写一个,rehype 可以将 md 解析成 ast ,你甚至可以自定义语法或者变量,最后输出成 vue template 交给 vite 编译,meilisearch 用于搜索,这套方案你甚至可以直接把 md 的 ast 解析成合适的数据喂给 langchain ,这样搜索+AI 都有了。至于换模版,这就是个 vue 项目,你想怎么定义怎么定义,我是用 tailwindcss + typography 插件
shimada666
133 天前
vitepress ,如果有自动侧边栏需求可以用 https://github.com/QC2168/vite-plugin-vitepress-auto-sidebar 插件
Moatkon
133 天前
https://starlight.astro.build/zh-cn/ 我的站点就是用这个构建的
smallyu
133 天前
有没有人用 jb 家的 Writeside
hongchends1
133 天前
我用的 mkdocs 还有 wiki.js
stevenshum
133 天前
@hongchends1 mkdocs-material +1 ,很好很强大
stevenshum
133 天前
@stevenshum https://weiyan.cc/ ,我的站点用的就是 mkdocs-material
zsh2517
133 天前
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
133 天前
我在用 可能没那么好看 但是还不错 docsify
Pters
133 天前
语雀
xiaojun996
133 天前
我用 vitepress
matthewzhong
133 天前
推荐 hugo ,我的博客:[码中人的博客]( https://blog.mzh.ren/zh/)

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/1003703

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX