Congo 主题安装与使用教程

1. 项目的目录结构及介绍

Congo 主题的目录结构如下：

congo/
├── archetypes/
├── assets/
├── config/_default/
├── data/
├── exampleSite/
├── i18n/
├── images/
├── layouts/
├── scripts/
├── static/
├── .gitignore
├── .prettierignore
├── .prettierrc
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── go.mod
├── lighthouserc.js
├── netlify.toml
├── package-lock.json
├── package.json
├── release.sh
├── tailwind.config.js
└── theme.toml

目录结构介绍

• archetypes/: 包含内容模板文件。
• assets/: 存放主题的静态资源文件，如 CSS、JavaScript 等。
• config/_default/: 包含项目的配置文件。
• data/: 存放自定义数据文件。
• exampleSite/: 包含示例站点的文件。
• i18n/: 存放国际化文件。
• images/: 存放图片资源。
• layouts/: 包含主题的布局文件。
• scripts/: 存放脚本文件。
• static/: 存放静态文件，如图片、字体等。
• .gitignore: Git 忽略文件。
• .prettierignore: Prettier 忽略文件。
• .prettierrc: Prettier 配置文件。
• CHANGELOG.md: 更新日志文件。
• CODE_OF_CONDUCT.md: 行为准则文件。
• CONTRIBUTING.md: 贡献指南文件。
• LICENSE: 许可证文件。
• README.md: 项目说明文件。
• go.mod: Go 模块文件。
• lighthouserc.js: Lighthouse 配置文件。
• netlify.toml: Netlify 配置文件。
• package-lock.json: npm 锁定文件。
• package.json: npm 配置文件。
• release.sh: 发布脚本文件。
• tailwind.config.js: Tailwind CSS 配置文件。
• theme.toml: 主题配置文件。

2. 项目的启动文件介绍

Congo 主题的启动文件主要是 config/_default/module.toml 和 config/_default/config.toml。

config/_default/module.toml

该文件用于配置 Hugo 模块，引入 Congo 主题。示例如下：

[[imports]]
path = "github.com/jpanther/congo/v2"

config/_default/config.toml

该文件是 Hugo 的主要配置文件，包含网站的基本设置、主题配置等。示例如下：

baseURL = "http://example.org/"
languageCode = "en-us"
title = "My New Hugo Site"
theme = "congo"

3. 项目的配置文件介绍

Congo 主题的配置文件主要位于 config/_default/ 目录下，包括 config.toml、module.toml 等。

config.toml

该文件包含网站的基本配置，如网站标题、语言、主题等。示例如下：

baseURL = "http://example.org/"
languageCode = "en-us"
title = "My New Hugo Site"
theme = "congo"

module.toml

该文件用于配置 Hugo 模块，引入 Congo 主题。示例如下：

[[imports]]
path = "github.com/jpanther/congo/v2"

theme.toml

该文件包含主题的特定配置，如颜色方案、布局等。示例如下：

[params]
  colorScheme = "auto"
  darkMode = "auto"

通过以上配置文件，您可以自定义 Congo 主题的外观和功能，以满足您的需求。