Hugo Black & Light 主题安装与使用指南

Hugo Black & Light 主题安装与使用指南

hugo-black-and-light-theme A High contrast, text oriented, performant and Javascript-free theme for Hugo. 项目地址: https://gitcode.com/gh_mirrors/hu/hugo-black-and-light-theme

1. 项目目录结构及介绍

hugo-black-and-light-theme/
├── archetypes/
│   └── default.md
├── exampleSite/
│   ├── config.toml
│   ├── content/
│   └── static/
├── images/
├── layouts/
│   ├── _default/
│   ├── partials/
│   └── shortcodes/
├── static/
│   ├── css/
│   ├── fonts/
│   └── images/
├── .gitignore
├── LICENSE
├── README.md
├── go.mod
└── theme.toml

目录结构说明

• archetypes/: 包含默认的内容模板文件 default.md，用于生成新内容时的默认格式。
• exampleSite/: 包含一个示例站点，用于展示主题的使用方式。
  • config.toml: 示例站点的配置文件。
  • content/: 示例站点的内容文件夹。
  • static/: 示例站点的静态资源文件夹。
• images/: 主题相关的图片资源。
• layouts/: 主题的布局文件夹，包含默认布局、部分布局和短代码。
  • _default/: 默认布局文件。
  • partials/: 部分布局文件。
  • shortcodes/: 短代码文件。
• static/: 主题的静态资源文件夹，包含CSS、字体和图片等。
• .gitignore: Git 忽略文件。
• LICENSE: 主题的许可证文件。
• README.md: 主题的说明文档。
• go.mod: Go 模块文件。
• theme.toml: 主题的配置文件。

2. 项目的启动文件介绍

Hugo 主题的启动文件通常是 config.toml 或 config.yaml，具体取决于你的配置文件格式。在 exampleSite/ 目录下，你可以找到一个示例配置文件 config.toml，它包含了主题的基本配置。

示例配置文件 config.toml

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

[params]
  description = "A High contrast, text oriented, performant and Javascript-free theme for Hugo."

启动步骤

1. 将 exampleSite/config.toml 复制到你的 Hugo 站点根目录。
2. 根据需要修改配置文件中的参数。
3. 运行 hugo server 启动本地服务器，预览站点。

3. 项目的配置文件介绍

主题的配置文件 theme.toml 位于主题的根目录下，包含了主题的基本信息和配置选项。

theme.toml 文件内容

name = "Black & Light"
license = "GPL-3.0"
licenselink = "https://github.com/davidhampgonsalves/hugo-black-and-light-theme/blob/master/LICENSE"
description = "A High contrast, text oriented, performant and Javascript-free theme for Hugo."
homepage = "https://github.com/davidhampgonsalves/hugo-black-and-light-theme"
tags = ["hugo-theme", "hugo"]
features = ["High Contrast", "Text Oriented", "Performant", "Javascript-free"]
min_version = "0.55.0"

配置文件说明

• name: 主题的名称。
• license: 主题的许可证类型。
• licenselink: 许可证文件的链接。
• description: 主题的描述。
• homepage: 主题的主页链接。
• tags: 主题的标签，用于分类。
• features: 主题的主要特性。
• min_version: 支持的最低 Hugo 版本。

通过这些配置文件，你可以轻松地定制和使用 Hugo Black & Light 主题。

hugo-black-and-light-theme A High contrast, text oriented, performant and Javascript-free theme for Hugo. 项目地址: https://gitcode.com/gh_mirrors/hu/hugo-black-and-light-theme