toha

英文原文正文为项目原始 README（英文），本站后续会翻译为中文，当前仅剔除图片与无关章节并统一排版。

Toha

一个用于个人作品集的 Hugo 主题，具有极简设计和响应式功能。

• 示例网站： toha-example-site
• 文档： toha-docs.netlify.app

功能

• 极简设计
• 完全响应式
• 多语言支持
• 精心设计的卡片
• 经验时间轴
• 成就画廊
• 侧边栏分类帖子
• 短代码
• 分析支持
  • GoatCounter
  • counter.dev
  • 谷歌分析
  • Matomo/Piwik
  • Umami
• 评论支持
  • Disqus
  • Valine
  • Utterances
  • Giscus

有关功能的更多详细信息，请访问这里。

可用翻译

• 英语
• বাংলা
• 法语
• 印尼语
• 德语
• 西班牙语
• 简体中文
• 繁體中文
• हिन्दी
• 意大利语
• 日本語
• 한국어
• русский
• 芬兰语
• 越南语
• 阿塞拜疆语
• 土耳其语
• 阿拉伯语 (العربية)
• 欧洲葡萄牙语
• 加泰罗尼亚语
• 巴西葡萄牙语
• 荷兰语
• 希伯来语

要了解有关如何翻译您的网站的更多信息，请访问 这里。请遵循此 示例网站 的数据和文章格式。

截图

这里是来自示例网站的一些截图。

首页版块

列表页面

阅读页面

要求

• Hugo 版本 0.163.0（扩展版）或更高
• Go 语言 1.19 或更高（Hugo 模块所需）
• Node 版本 v18.x 或更高，npm 8.x 或更高。

使用方法

使用此主题的最简单方法是分叉 toha-example-site 示例仓库。然后根据你的需要更改配置。

如果你想从头开始，请按照以下步骤操作：

1. 在你的仓库中初始化 Hugo 模块

首先，在你的仓库中初始化 Hugo 模块。这将创建一个 go.mod 文件。

hugo mod init github.com/<your username>/<your repo name>

2. 将此主题作为您的模块依赖项添加

现在，在您的 hugo.yaml 文件中，添加一个 module 部分。

# Use Hugo modules to add theme
module:
  imports:
    - path: github.com/hugo-toha/toha/v4

查看此示例 hugo.yaml 以获取更多参考。

3. 更新你的模块

现在，运行此命令以将此主题作为你的模块加载。

hugo mod tidy

本地运行

现在，你可以按照以下步骤在本地运行你的 Hugo 网站：

1. 生成节点依赖配置

现在运行以下命令以生成节点依赖配置。这将在你的仓库中创建一个 package.json 文件。

hugo mod npm pack

2. 安装依赖

使用以下命令安装节点依赖：

npm install

3. 运行你的网站

现在，使用以下命令在本地运行你的网站。

hugo server -w

当您第一次运行您的网站时，它将使用默认参数启动。它应该看起来类似于 示例网站。然而，由于我们还没有配置首页的任何部分，它将没有任何内容。您可以通过按照 这里 的指南来配置您的网站。

短代码

这里有一些你可以在此主题中使用的便捷短代码。

• 警报
• 图片
• 分割
• 垂直间距
• 视频
• 美人鱼图

贡献

您可以通过多种方式为此主题做出贡献。您可以报告一个错误，提交一个功能请求，发送一个PR，分享您的想法等。

非常欢迎提交拉取请求，我会很高兴进行审核。只需遵循以下原则：

• 保持简洁。
• 保持与设计的一致性。
• 尽量使用最少的依赖。
• 保持耐心。

我不是一名网页开发人员。我创建这个主题是为了我的个人需求。因此，代码中存在一些缺陷是合理的。请随时提出问题和PR，指出这些问题。

本地开发

对于本地开发，你可以在主题子模块中进行更改，并在你自己的网站或这个 示例网站 上本地测试这些更改。

1. 分叉

首先，分叉 这个仓库。然后，按照以下步骤使用分叉的主题进行本地开发，

我们在 exampleSite 文件夹下有一个示例配置，可以让你在本地运行主题。按照下面的步骤来运行示例网站。

2. 安装 Mise

我们使用 jdx/mise 来简化依赖管理和本地运行。请按照 这里 的说明进行安装。

3. 安装依赖

通过运行以下命令安装所有必要的工具：

mise install

这将安装 hugo、go、node 以及运行此项目所需的其他工具到适当的版本。

4. 运行示例站点

现在，使用以下命令在本地运行站点。

mise run example-site

现在，您可以更改主题，这些更改将立即反映在正在运行的网站上。如果您需要更改任何配置，可以在 exampleSite 文件夹内的 hugo.yaml 文件中进行。如果您需要添加任何内容或数据，可以在 exampleSite 目录中创建相应的文件夹，并在其中添加所需的内容或数据。

在您自己的网站上运行已分叉的主题

如果您想在自己的网站上运行本地开发，请按照以下步骤操作：

替换主题模块：

打开您网站的 go.mod 文件，将 github.com/hugo-toha/toha/v4 替换为您的分叉仓库路径。例如，如果您的分叉仓库是 github.com/<your-github-user>/toha，则将 github.com/hugo-toha/toha/v4 替换为 github.com/<your-github-user>/toha/v4。

module github.com/hugo-toha/hugo-toha.github.io

go 1.19

require github.com/hugo-toha/toha/v4 v4.0.1-0.20231229170427-d3968ca711ef // indirect

replace(
    github.com/hugo-toha/toha/v4 => github.com/<your-github-user>/toha/v4 <git branch>
)

对于交互式开发，您可以将主题替换为本地克隆的分支。例如，如果您已将分支克隆到 /home/my-projects/toha，则将 github.com/hugo-toha/toha/v4 替换为 /home/my-projects/toha。

module github.com/hugo-toha/hugo-toha.github.io

go 1.19

require github.com/hugo-toha/toha/v4 v4.0.1-0.20231229170427-d3968ca711ef // indirect

replace(
    github.com/hugo-toha/toha/v4 => /home/my-projects/toha
)

更新依赖项：

# update hugo modules
$ hugo mod tidy
# install dependencies
$ hugo mod npm pack
$ npm install

在本地运行你的网站：

hugo server -w

从那里，你可以在运行你的 Hugo 站点或示例站点进行测试的同时，对主题的源代码进行更改。

打开一个 PR

当更改看起来不错时，将它们提交并推送到你的分叉仓库。

# stage all the changes
$ git add .
# commit the changes with a meaning full commit message
$ git commit -m "A meaningful commit message"
# push the commit to your fork
$ git push my-fork my-feature-branch

然后，从你自己 fork 的 my-feature-branch 分支对 hugo-themes/toha 的 main 分支发起一个 PR。

归属

• 感谢 Anup Deb 提供他的设计指导。
• 许多插图取自 iconscout。