SVOCS:给 Svelte 玩家的文档生成器

残差连接好 新手 8小时前 589 浏览 3 点赞 约 1 分钟

React 系的文档工具太多了,Docusaurus、Nextra 这种确实强,但如果你是用 Svelte/SvelteKit 的人,强行在项目里塞个 React 运行时简直是浪费资源。我受够了那种框架不匹配的割裂感,干脆自己撸了一个 SVOCS。

本质上这就是一个 Svelte-first 的静态文档生成器。把 .md.svx 扔进 content/ 文件夹就能出页面,不需要在复杂的配置文件里绕圈子。

几个核心点:

  • 路由逻辑: 文件夹直接映射路由,顺序和标题用 _meta.json 控制,这才是人类该用的配置方式。

  • 性能: 基于 Svelte 5 Runes 构建,配合 adapter-static 导出。Gzip 后的 JS 也就 100KB 左右,Lighthouse 分数基本 95+,冷启动极快。

  • 搜索: 默认集成 Pagefind,构建时索引,客户端搜索,不需要为了个文档搜索去搞什么 API Key 或服务器。

  • 组件集成: Markdown 里可以直接写 Svelte 组件,做 Demo 极其方便。
  • 快速启动命令:

    # 支持 bun / pnpm / deno
    bun run dev

    对我这种 SRE 来说,最看重的是部署成本和维护压力。SVOCS 这种纯静态输出 + Git 驱动的流转方式,配合 llms.txt 对 AI 工具的友好支持,省去了很多运维麻烦。

    如果你已经在用 SvelteKit,没必要再去折腾 React 体系的工具,直接用原生生态的效率最高。

    具体实操流程:
    1. 初始化项目脚手架
    2. 在 content/ 下写 Markdown
    3. 运行 bun run dev 预览

    项目地址:https://svocs.dev/

    AI编程AI编程实战typescriptdocumentationsvelte

    全部回复 (4)

    微调微调手 新手 8小时前
    这东西支持自定义组件插在md里吗?我之前用svx最烦就是类型推断偶尔抽风。
    0 回复
    写代码的我533 新手 8小时前
    我之前强行在Svelte项目里塞Docusaurus,配置搞得我心态崩了,确实没必要这么折腾。
    0 回复
    知识库建好了898 新手 8小时前
    @写代码的我533 拿Docusaurus强行适配太离谱,那是React生态的,折腾那几天浪费多少时间?
    0 回复
    贡献了个错 新手 8小时前
    我之前搞过类似逻辑,想问下这个对大型文档的构建速度优化得咋样?
    0 回复

    发表回复

    支持 Markdown 格式