Repolode
nuxt-content

nuxt-content/docus

基于 Nuxt 的文档站点生成器,使用 Markdown 和 Vue 组件编写文档。

可替代:GitBookReadMe

Star
3,117
Fork
292
未关闭 Issue
40
最近提交
前天

这是什么?

Docus 是基于 Nuxt 构建的文档框架。通过一条 CLI 命令即可生成文档项目,页面使用 Markdown 编写,并可通过 MDC 语法嵌入 Vue 组件。生成的站点包含响应式主题、深色模式、客户端搜索,以及用于多语言文档的 i18n 模板。

除静态站点外,Docus 还提供面向 AI 的功能:内置可根据文档回答问题的助手对话组件,位于 /mcp 的 MCP 服务器可供编辑器和 AI 工具连接,并能自动生成 llms.txt 与 llms-full.txt。放在 skills 目录中的技能会通过 /.well-known/skills/ 提供访问。

项目采用 monorepo 结构,包含 create-docus 命令行工具、提供主题的 docus Nuxt layer,以及官方文档站点。项目基于 Nuxt 4、Nuxt UI 4 和 Tailwind CSS 4,也可以通过 Vercel 模板一键部署。

核心功能

  • 01使用 Markdown 编写页面,并通过 MDC 语法嵌入 Vue 组件。
  • 02通过一条 npx 命令创建文档项目,可选 i18n 多语言模板。
  • 03内置客户端搜索,并可选 FTS5 全文搜索后端。
  • 04支持深色模式、响应式布局,并可基于 Nuxt UI 4 与 Tailwind CSS 4 自定义主题。
  • 05内置 MCP 服务器,并自动生成 llms.txt,便于 AI 工具使用。
  • 06自带 sitemap、robots.txt 和 Open Graph 图片生成。

适用场景

  • 用 Markdown 编写并发布产品或开源库的文档站点。
  • 借助 i18n 模板搭建多语言文档网站。
  • 通过 MCP 服务器和 llms.txt 让 AI 助手读取项目文档。
  • 基于 Nuxt 快速搭建文档站,并用自定义页面和组件扩展。

标签

常见问题

docus 是什么?
基于 Nuxt 的文档站点生成器,使用 Markdown 和 Vue 组件编写文档。 Docus 是基于 Nuxt 构建的文档框架。通过一条 CLI 命令即可生成文档项目,页面使用 Markdown 编写,并可通过 MDC 语法嵌入 Vue 组件。生成的站点包含响应式主题、深色模式、客户端搜索,以及用于多语言文档的 i18n 模板。
docus 可以免费使用吗?用的什么许可证?
docus 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
docus 还在维护吗?
活跃维护中。docus 最近一次提交是在 2026年10月16日。
docus 适合用来做什么?
用 Markdown 编写并发布产品或开源库的文档站点。 借助 i18n 模板搭建多语言文档网站。 通过 MCP 服务器和 llms.txt 让 AI 助手读取项目文档。 基于 Nuxt 快速搭建文档站,并用自定义页面和组件扩展。
在哪里获取 docus?
源代码和安装说明在 GitHub 上:https://github.com/nuxt-content/docus

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目