Hosting Documentation For
为什么开发者讨厌写文档?
SaaS 平台太贵
GitBook 团队版起步价 $400/月?对于开源项目和初创团队来说,这是一笔不小的开销。我们提供几乎免费的替代方案。
GitHub Wiki 太简陋
缺乏自定义域名、没有全文搜索、不支持深色模式,SEO 更是灾难。你的好项目值得一个更好的门面。
自建维护麻烦
买服务器、配 Nginx、搞定 SSL 证书、配置 CD 流程... 你的时间应该花在写代码上,而不是运维上。
任何类型的文档,都能完美承载
开源项目文档
自动为你的 GitHub Repo 生成文档站点。每次 Push 自动更新。支持自定义域名 (docs.your-project.com)。
API 参考手册
完美支持 OpenAPI / Swagger 渲染。双栏布局,左侧导航右侧代码,清晰易读。
内部知识库 (Wiki)
为团队搭建私有文档。支持密码保护(Pro功能)。
产品使用手册
帮助用户快速上手。支持嵌入视频教程和 GIF 演示。
设计规范 (Design System)
展示组件库。支持 React/Vue 组件实时预览。
支持所有主流 SSG 框架
常见问题
我可以使用 Docusaurus 或 VitePress 吗?
当然。您只需要运行 `npm run build` 生成静态文件(通常在 `dist` 或 `build` 目录),然后将其部署。我们完美支持 Deep Linking 和 SPA 路由。
如何配置自定义域名?
在部署完成后,进入设置页面添加您的域名(如 docs.example.com)。我们将自动为您配置 CNAME 并签发 Let's Encrypt SSL 证书。
支持私有文档吗?
目前我们主要面向公开的开源文档。私有仓库和密码保护功能正在开发中,预计将在 Pro 计划中提供。
SEO 效果如何?
极佳。我们生成的站点是静态 HTML,对 Google 爬虫非常友好。同时我们的 CDN 确保了极快的加载速度(TTFB),这是搜索引擎排名的重要指标。
为你的代码,配上最好的说明书
拖拽上传生成的 HTML 文件夹,10秒内上线全球。
点击选择文件或 Zip 包
支持 .html, .zip, .pdf, .png, .jpg
支持 .html, .css, .js 及所有静态资源