欢迎来到Docsy

欢迎使用Docsy主题用户指南！本指南向您展示如何开始使用Docsy创建技术文档网站，包括网站定制以及如何使用Docsy的块和模板。

什么是Docsy？

Docsy是[雨果]的主题 (https://gohugo.io/) 静态网站生成器，专门为技术文档集设计，并内置了许多最佳实践。使用Docsy可以快速启动和运行一个可工作且可靠的文档网站，然后重新关注用户的精彩内容。了解更多关于Docsy的信息>.

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

Docsy本身并不提供：

-源代码托管和管理：我们的主题和网站源代码文件位于[GitHub]上(https://github.com/)，这是大多数项目中最简单的方法。但是，您也可以将项目文件保存在[GitLab]中(https://about.gitlab.com/)，BitBucket»、本地或任何您喜欢的地方。请注意，源文件所在的位置可能会影响您可以使用的Docsy功能（例如让用户提交文档问题）和站点部署选项。>

-站点部署：您可以在[预览和部署]中找到有关部署选项的信息(</docs/deployment/>). 此网站使用Netlify.

Docsy实际上也不会生成网站的HTML文件：这是Hugo的工作！Hugo将您的Markdown或HTML文档源文件和Docsy的主题文件构建到一个静态站点中进行部署。您可以在[Hugo文档]中了解更多关于Hugo及其工作原理的信息(https://gohugo.io/documentation/).

Docsy适合我吗？

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

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

-一个更简单的Hugo或Jekyll主题：在GitHub Pages的[内置的Jekyll选项]中找到可用的内容(https://pages.github.com/themes/)和雨果主题>.

-一个好的自述文件，告诉用户你的项目做什么，并链接到一些例子。

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

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

准备好开始了吗？

在[入门]中了解如何构建和服务您的第一个网站(</docs/get-started/>). 或者访问示例网站以及其回购开始探索吧！