Hugo 主题
Docsy
🚧 警告 🚧 : main
分支正在开发中,可能不稳定!请使用官方 Docsy 发布版本。
Docsy 是一个用于技术文档集的 Hugo 主题,提供简单的导航、站点结构等功能。
这不是 Google 官方支持的产品。此项目正在积极维护中。
先决条件
以下是在您的站点中使用 Docsy 的基本先决条件
安装最新发布的 Hugo “扩展”版本。 如果您从 Hugo 发布页面安装,请确保下载支持 SCSS 的
extended
版本。安装
PostCSS
,以便站点构建可以创建最终的 CSS 资源。 您可以通过从项目的根目录运行以下命令在本地安装它npm install --save-dev autoprefixer npm install --save-dev postcss-cli
从
postcss-cli
的版本 8 开始,您还必须单独安装postcss
npm install -D postcss
任何其他先决条件都取决于您选择的安装选项。 我们建议将 Docsy 用作 Hugo 模块,这要求除了 Hugo 和 PostCSS 之外,您还安装了 Go 语言。
有关完整的先决条件和说明,请参阅我们的入门指南。
示例和用法
您可以在 Docsy 示例项目存储库中找到使用 Docsy 的示例项目。Docsy 示例项目托管在 example.docsy.dev 上。 有关使用 Docsy 的站点的真实示例(及其源存储库),请参阅我们的示例页面。
要将 Docsy 主题用于您自己的站点
(推荐)使用示例项目,其中包括作为 Hugo 模块的 Docsy 主题,作为创建项目的模板。 您可以将这个预配置的基本站点自定义为您自己的 Docsy 主题站点。 了解更多…
将 Docsy 添加到您现有的 Hugo 站点。 您可以将 Docsy 添加为 Hugo 模块、Git 子模块,或将 Docsy 主题克隆到您的项目中。
有关各种使用选项的详细信息,请参阅入门指南。
文档
Docsy 有自己的用户指南(当然,使用 Docsy!),其中包含有关使用主题的更多信息。 它由 Netlify 托管在 docsy.dev。 有关部署日志和更多信息,请参阅该站点的 Netlify 仪表板中的部署。
或者,您可以使用 Hugo 生成并提供指南的本地副本(也适用于测试本地主题更改),确保您已安装上面列出的所有先决条件
git clone --depth 1 https://github.com/google/docsy.git
cd docsy/userguide/
npm install
npm run serve
贡献
有关我们的行为准则和提交拉取请求的流程的详细信息,请参阅 CONTRIBUTING.md。 感谢所有过去、现在和未来的贡献者!
许可证
此项目根据 Apache 许可证 2.0 获得许可 - 有关详细信息,请参阅 LICENSE.md 文件