Hugo 主题
Geekdoc
Geekdoc 是一个简单的 Hugo 文档主题。它被有意设计成快速且简洁的主题,可能不适合复杂项目的需求。如果需要功能更完整的主题,还有很多不错的替代方案。您可以在 https://geekdocs.de 上找到演示和完整文档。
构建和发布流程
这个主题遵循软件开发中常见的 CI 驱动的构建和发布流程。在发布构建期间,所有必要的资源都由 webpack 自动构建并捆绑到发布 tarball 中。您可以从 GitHub 发布页面下载最新版本。
由于 webpack
和 npm scripts
被用作预处理器,因此默认情况下无法从主分支使用该主题。如果您想从克隆的分支而不是发布 tarball 中使用该主题,则需要在本地安装 webpack
并运行一次构建脚本以创建所有必需的资源。
# install required packages from package.json
npm install
# run the build script to build required assets
npm run build
# build release tarball
npm run pack
有关不同设置选项的详细信息,请参阅入门指南。
贡献者
特别感谢所有贡献者。如果您想做出贡献,请参阅说明。
Geekdoc 的灵感部分来自 hugo-book 主题,感谢 Alex Shpak 的工作。
许可证
该项目根据 MIT 许可证获得许可 - 有关详细信息,请参阅 LICENSE 文件。
使用的 SVG 图标和生成的图标字体均根据各自图标包的许可证获得许可
- Font Awesome:CC BY 4.0 许可证
- IcoMoon Free Pack:GPL/CC BY 4.0
- Material Icons:Apache License 2.0