介绍

什么是 LiteDocs？

LiteDocs 基于 Tailwind CSS、MDX 和 Next.js 构建，旨在简单易用，并且便于自定义。

动机

文档应该易于编写且能够快速发布。LiteDocs 专注于「作者优先」的工作流，你只需要编写 MDX，可选地插入 React 组件，即可发布一个高性能的 Next.js 文档站，而无需引入庞大复杂的框架。

• 减少搭建时间 — 在几分钟内运行一个文档网站。
• 避免供应商锁定 — 内容完全存放在本地的 src/content 目录中。
• 偏向组合而非配置 — 通过小而精的 React 组件完成自定义。
• 提供合理默认值 — 包含排版、主题、布局和导航等默认设置。

理念

• 内容优先：写作应该是核心流程，而不是配置工具链。
• 约定优于配置：可预测的文件结构与默认行为。
• 可组合 UI：由可替换、可扩展的小型组件构成。
• 性能与可访问性：提供快速加载、具备可访问性的页面。
• 内部透明：清晰易读、易于修改的代码。

常见问题