概述

用于快速且一致地搭建 Vercel 文档微站点的现代文档模板

Geistdocs 是一个生产就绪的文档模板,基于 Next.js 16 和 Fumadocs 构建。它被设计为 Vercel 的内部模板,用于在各个项目中创建具有一致外观、体验和功能集的文档微站点。

概述

该模板提供了构建美观且功能齐全的文档站点所需的一切,且只需最少的设置。它将用于内容创作的 MDX 的强大功能与诸如 AI 驱动的聊天、GitHub Discussions 集成和高级搜索功能等现代特性相结合。

使用场景

该模板非常适合:

  • 产品文档 - 功能指南、教程和参考
  • API 文档 - 带代码示例的接口文档
  • 开发者工具 - CLI 工具、SDK 和框架文档
  • 内部维基 - 团队知识库和指南
  • 项目文档 - 开源项目文档

包含内容

Geistdocs 由三部分组成:

  • template - 你将用来创建文档站点的模板。
  • platform - 你的文档站点将用于处理反馈和翻译的后端。
  • cli - 用于创建和管理文档站点的 CLI。

支持

如遇问题、有疑问或想贡献:

  • 查看文档页面以获取详细指南
  • 使用内置反馈小部件报告问题
  • 使用 AI 聊天助手提问

On this page

GitHubEdit this page on GitHub