Docsy

什么是Docsy？

Docsy是Hugo静态站点生成器的一个主题，专为技术 文档集，并内置了许多最佳实践。使用Docsy获得一个有效和可靠的文档 网站快速启动并运行，然后重新专注于为用户提供优质内容。了解更多关于Docsy的信息。

除了主题本身之外，我们还提供了一个示例网站，它使用了很多Docsy功能，并为一个大型技术文档集提供了一个有用的骨架网站结构（并提供了在其中放置什么的建议！你可以复制整个网站，并为你自己的项目进行编辑，或者只是浏览网站及其来源，看看Docsy能做什么。你目前正在阅读的网站也使用了Docsy，是一个较小的Docsy文档集的一个有用的例子：如果它比 “大 ”的例子更适合你的需求，你可以随意复制它或借用它。

Docsy本身不提供。

• 源托管和管理：我们的主题和站点源文件位于 GitHub 上，这是大多数项目最简单的方法。但是，您也可以将项目文件保存在 GitLab、BitBucket、本地或任何您喜欢的地方。请注意，源文件所在的位置可能会影响您可以使用的 Docsy 功能（例如让用户提交文档问题）和站点部署选项。
• 站点部署：可以在预览和部署中找到有关部署选项的信息。本网站使用Netlify。

Docsy实际上也不会生成你网站的HTML文件：这是Hugo的工作！Hugo 获取你的 Markdown 或 HTML 文档源文件和 Docsy 的主题文件，并将它们构建到一个静态站点中进行部署。您可以在 Hugo 文档中找到有关 Hugo 及其工作原理的更多信息。

Docsy适合我吗？

Docsy 对于包含 20+ 页文档和/或多种类型的文档和页面的大中型技术文档集特别有用：教程、参考文档、博客文章、社区页面等。

如果你有一个较小的项目，只有几页的文档，因此需要更简单的导航，Docsy对你来说可能是一个太重量级的解决方案。相反，请考虑：

• 更简单的 Hugo 或 Jekyll 主题：了解 GitHub Pages 的内置 Jekyll 选项和 Hugo 主题库中可用的内容。
• 一个很好的 README 文件，告诉用户您的项目是做什么的，并链接到一些示例。

如果你有一个非常大的文档项目，我们的示例网站结构可能也不够用，但你仍然可以使用我们的主题，可能使用更重的自定义。

如果你想使用Docsy的布局，但更喜欢使用Jekyll，vsoch已经创建了一个Docsy Jekyll移植，其中包含Docsy的许多功能（尽管这是一个单独的项目，它不会与Docsy一起自动更新）。