ShipAny Docs 是什么?
ShipAny Docs 是一个独立的文档站模板,基于 Fumadocs 和 TanStack Start 构建。你只需编写 Markdown(MDX)文件,就能得到带侧边导航、全文搜索、深色模式和中英文支持的文档网站。
它设计为与主产品分开部署——放在 docs.yourdomain.com,或挂在 /docs 这样的路径下。ShipAny 自己的文档就运行在这个模板上。
适合谁
- 需要用户文档的 SaaS 产品
- 开发者工具与 API
- 同时发布中英文文档的团队
- 在一个站点里维护多个产品文档的公司
核心功能
MDX 内容
content/docs 下的每个 .mdx 文件都是一个页面,用 frontmatter 设置标题、描述和侧边栏顺序。
约定式双语
page.mdx 是英文,page.zh.mdx 是中文版本,语言切换和 URL 自动生成。
全文搜索
内置 Orama 搜索,同样支持中文内容。
几分钟完成品牌与主题
用环境变量设置名称、Logo 和链接,把任意 shadcn / tweakcn 主题粘贴到一个 CSS 文件即可。
支持多产品
可选的侧边栏下拉菜单,在一个文档站中切换不同产品。
随处部署
可运行在 Node 服务器、Cloudflare Workers 或 Docker 上。
包含内容
- 框架
- TanStack Start、React
- 文档引擎
- Fumadocs(MDX)
- 搜索
- Orama,支持中文
- 语言
- 中文与英文
- 主题
- src/styles/theme.css 中的 shadcn/ui 主题,深色模式
- 部署
- Node、Cloudflare Workers、Docker
如何开始
- 1
本地运行
克隆仓库、安装依赖并启动开发服务器,按快速开始文档约五分钟即可跑起来。
- 2
编写内容
在 content/docs 下添加 MDX 页面和对应的 .zh.mdx 中文版本,并在 meta.json 中排序。
- 3
设置品牌并部署
配置名称、Logo 和主题,然后部署到 Node、Cloudflare Workers 或 Docker。
可以用 ShipAny Docs 做什么
产品文档
面向 SaaS 用户的使用指南和参考手册。
API 文档
面向开发者的接口说明和代码示例。
帮助中心
可搜索的中英文常见问题和教程。
常见问题
必须搭配 ShipAny SaaS 模板使用吗?
不需要。ShipAny Docs 是独立站点,适用于任何产品。
能添加中英文以外的语言吗?
默认配置了中文和英文;多语言遵循 Fumadocs 的约定,可以在代码中添加更多语言。
可以放在主域名的 /docs 路径下吗?
可以。部署到子域名,或把 /docs 这样的路径路由到它——shipany.ai/docs 就是这样做的。
技术说明(README)
What is ShipAny Docs?
ShipAny Docs is a standalone documentation site template, built on fumadocs and TanStack Start.
You write Markdown (MDX) files, and it gives you a polished docs site with sidebar navigation, full-text search, dark mode, and English/Chinese support out of the box.
It is designed to be deployed separately from your main product, e.g. at
docs.yourdomain.com.
