跳到正文
@amamo/doctrine

开箱即用的静态文档

只需一个 MDX 目录。

Doctrine 自动补齐导航、搜索、多语言、明暗主题和静态产物，本地即可预览，也能直接部署到任意静态平台。

开始使用查看功能说明

一份源码，一条完整路径

  1. 编写 MDX
  2. 预览全部路由
  3. 发布静态文件

使用你的包管理器安装 Doctrine

Shell
pnpm add @amamo/doctrine

  1. 第一次运行就完整可用

    启动开发服务器即可获得导航、搜索、主题和响应式布局，不必再拼装一套技术栈。

  2. 从设计上就是静态的

    每条路由都会预渲染并建立索引，部署产物只是普通静态文件，不需要 Node.js 服务器。

  3. 部署不留意外

    GitHub Pages 上的仓库子路径、语言路由、资源、搜索结果和 404 页面都会保持正确。

精简源码，完整站点

只管写文档，网站会自行组装。

让内容与导航元数据就近放置。Doctrine 会将目录转换成路由，并在发布前校验整棵内容树。

  • 多语言内容与导航
  • Pagefind 搜索
  • 持久化明暗主题
  • 自定义 React 与 MDX 组件
  • 支持子路径的静态部署