Hugo 主题
congo
一个功能强大、轻量级的 Hugo 主题,使用 Tailwind CSS 构建。
Congo
Congo 被设计为一个功能强大、轻量级的 Hugo 主题。它使用 Tailwind CSS 构建,具有简洁简约的设计,优先考虑您的内容。
🌏 演示站点
📑 主题文档
🐛 错误报告和问题
💡 问题和功能请求
功能
- 使用 Tailwind CSS 3.0 构建的完全响应式布局
- 多种配色方案(或完全自定义您自己的配色方案)
- 深色模式(强制开启/关闭或使用用户切换自动切换)
- 高度可自定义的配置
- 多个主页布局
- 灵活适用于任何内容类型、分类法和菜单
- 多语言内容支持,包括对 RTL 语言的支持
- 能够链接到第三方网站上的帖子
- 由 Fuse.js 提供支持的客户端站点搜索
- 使用 Mermaid 的图表和可视化
- 使用 Chart.js 的图表
- 使用 KaTeX 的数学符号
- 来自 FontAwesome 6 的 SVG 图标
- 使用 Hugo Pipes 自动调整图像大小
- 标题锚点、目录、代码复制、按钮、徽章等
- 文章中支持 HTML 和 Emoji 🎉
- SEO 友好,带有用于分享到社交媒体的链接
- 支持 Fathom Analytics、Plausible Analytics、Umami Analytics 和 Google Analytics
- RSS 源、Favicons 和评论支持
- 使用简单的 Tailwind 颜色定义和样式进行高级自定义
- 针对性能和可访问性进行了优化,具有完美的 Lighthouse 分数
- 提供完整文档,并定期更新
文档
Congo 拥有涵盖主题各个方面的详尽文档。请务必阅读文档,以了解有关如何使用主题及其功能的更多信息。
安装
Congo 支持多种安装方法 - 作为 Hugo 模块(最简单)、git 子模块或完全手动安装。
每种方法的详细说明都可以在安装文档中找到。您应该查阅文档以获得最简单的设置体验。如果您已经有安装 Hugo 主题的经验,下面是使用 Hugo 模块的快速入门指南。
使用 Hugo 快速入门
注意:请确保您已安装 Go 和 Hugo,并且在继续操作之前创建了一个新的 Hugo 项目。
从您的项目目录中,初始化 Hugo 模块
hugo mod init github.com/<username>/<repo-name>
创建
config/_default/module.toml
并添加以下内容[[imports]] path = "github.com/jpanther/congo/v2"
使用
hugo server
启动服务器,主题将自动下载。在您的网站根文件夹中,删除 Hugo 生成的
config.toml
文件。将主题中的*.toml
配置文件复制到您的config/_default/
文件夹中。注意:请勿覆盖您上面创建的
module.toml
文件!您将在 Hugo 缓存目录中找到这些主题配置文件,或从 GitHub 下载副本。
按照入门说明配置您的网站。
安装主题更新
发布新版本后,您可以使用 Hugo 更新主题。只需从您的项目目录运行 hugo mod get -u
,主题将自动更新到最新版本。
详细的更新说明可在文档中找到。
贡献
Congo 预计会随着时间的推移而发展。我打算根据需要不断添加功能和进行更改。
如果您有任何问题或新功能的建议,请随时与我联系。
- 🐛 错误报告和问题:使用 GitHub Issues
- 💡 新功能的想法:在 GitHub Discussions 上发起讨论
- 🙋♀️ 一般问题:前往 GitHub Discussions
如果您能够修复错误或实现新功能,我欢迎为此目的提交 PR。在贡献指南中了解更多信息。