Skip to content

Commit

Permalink
Docs: rename config.toml to hugo.toml
Browse files Browse the repository at this point in the history
  • Loading branch information
Lruihao committed Nov 26, 2023
1 parent a31612d commit 9042634
Show file tree
Hide file tree
Showing 10 changed files with 20 additions and 20 deletions.
12 changes: 6 additions & 6 deletions content/documentation/basics/index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ git submodule set-branch -b dev themes/FixIt
<!-- markdownlint-disable-next-line no-bare-urls -->
{{< link "https://github.com/hugo-fixit/hugo-fixit-blog-go" "A Template base on Hugo Module" "" true >}}

> In this way, you don't need to configure `theme = "FixIt"` in `config.toml`.
> In this way, you don't need to configure `theme = "FixIt"` in `hugo.toml`.
The easiest way to use a [Module][hugo-modules] for a theme is to import it in the config. See [Use Hugo Modules][use-hugo-modules].

Expand All @@ -99,11 +99,11 @@ The easiest way to use a [Module][hugo-modules] for a theme is to import it in t

## Full Configuration

Before starting configuration, it is recommended that you execute the following command to copy the default [config.toml][config] of theme to your project:
Before starting configuration, it is recommended that you execute the following command to copy the default [hugo.toml][config] of theme to your project:

```bash
mv config.toml config.old.toml
cp themes/FixIt/config.toml config.toml
mv hugo.toml hugo.old.toml
cp themes/FixIt/hugo.toml hugo.toml
```

### Menu Configuration {#menu-configuration}
Expand Down Expand Up @@ -170,7 +170,7 @@ menu:

In addition to [Hugo global configuration][hugo-config] and [menu configuration](#menu-configuration), **FixIt** lets you define the following parameters in your site configuration.

Please open the code block below to view the complete `config.toml` sample configuration :(fa-regular fa-hand-point-down fa-fw)::
Please open the code block below to view the complete `hugo.toml` sample configuration :(fa-regular fa-hand-point-down fa-fw)::

```toml
[params]
Expand Down Expand Up @@ -1279,7 +1279,7 @@ By the way, as these translations could be used by other people, please take the
[git-submodule]: https://git-scm.com/book/en/v2/Git-Tools-Submodules
[hugo-modules]: https://gohugo.io/hugo-modules/
[use-hugo-modules]: https://gohugo.io/hugo-modules/use-modules/
[config]: https://github.com/hugo-fixit/FixIt/blob/master/config.toml
[config]: https://github.com/hugo-fixit/FixIt/blob/master/hugo.toml
[menu-system]: https://gohugo.io/content-management/menus/
[hugo-config]: https://gohugo.io/overview/configuration/
[lunrjs]: https://lunrjs.com/
Expand Down
12 changes: 6 additions & 6 deletions content/documentation/basics/index.zh-cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ git submodule set-branch -b dev themes/FixIt
<!-- markdownlint-disable-next-line no-bare-urls -->
{{< link "https://github.com/hugo-fixit/hugo-fixit-blog-go" "基于 Hugo 模块的快速入门模板" "" true >}}

> 以这种方式,无需要在 `config.toml` 中配置 `theme = "FixIt"`
> 以这种方式,无需要在 `hugo.toml` 中配置 `theme = "FixIt"`
[Hugo 模块][hugo-modules] 用于主题的最简单方法是将其导入配置中。请参阅 [使用 Hugo 模块][use-hugo-modules]

Expand All @@ -98,11 +98,11 @@ git submodule set-branch -b dev themes/FixIt

## 完整配置

在开始配置之前,建议您执行以下命令,将主题的默认 [config.toml][config] 复制到您的项目中:
在开始配置之前,建议您执行以下命令,将主题的默认 [hugo.toml][config] 复制到您的项目中:

```bash
mv config.toml config.old.toml
cp themes/FixIt/config.toml config.toml
mv hugo.toml config.old.toml
cp themes/FixIt/hugo.toml hugo.toml
```

### 菜单配置 {#menu-configuration}
Expand Down Expand Up @@ -168,7 +168,7 @@ menu:

除了 [Hugo 全局配置][hugo-config][菜单配置](#menu-configuration) 之外,**FixIt** 主题还允许您在网站配置中定义以下参数。

请打开下面的代码块查看完整的 `config.toml` 示例配置 :(fa-regular fa-hand-point-down fa-fw)::
请打开下面的代码块查看完整的 `hugo.toml` 示例配置 :(fa-regular fa-hand-point-down fa-fw)::

```toml
[params]
Expand Down Expand Up @@ -1271,7 +1271,7 @@ defaultContentLanguage = "zh-cn"
[git-submodule]: https://git-scm.com/book/en/v2/Git-Tools-Submodules
[hugo-modules]: https://gohugo.io/hugo-modules/
[use-hugo-modules]: https://gohugo.io/hugo-modules/use-modules/
[config]: https://github.com/hugo-fixit/FixIt/blob/master/config.toml
[config]: https://github.com/hugo-fixit/FixIt/blob/master/hugo.toml
[menu-system]: https://gohugo.io/content-management/menus/
[hugo-config]: https://gohugo.io/overview/configuration/
[lunrjs]: https://lunrjs.com/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -814,7 +814,7 @@ Head to the [Theme Configuration | Mermaid][mermaid-theming] page to learn more

#### Site-wide Themes

You can configure mermaid themes globally in `config.toml` via the `params.mermaid` parameter.
You can configure mermaid themes globally in `hugo.toml` via the `params.mermaid` parameter.

#### Diagram-specific Themes

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -814,7 +814,7 @@ Mermaid 的 C4 图语法与 PlantUML 兼容。以下是示例:

#### 站点范围主题

您可以通过 `config.toml` 中的 `params.mermaid` 参数全局配置 Mermaid 主题。
您可以通过 `hugo.toml` 中的 `params.mermaid` 参数全局配置 Mermaid 主题。

#### 图表特定主题

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ hugo new friends/index.md

{{< version 0.2.12 >}} See [PWA Support][pwa-support] for details.

Set `type: offline` in the front matter and set `enablePWA` in `config.toml`:
Set `type: offline` in the front matter and set `enablePWA` in `hugo.toml`:

```toml
[params]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ hugo new friends/index.md

{{< version 0.2.12 >}} 详见 [PWA 支持][pwa-support]

在前置参数中设置 `type: offline`,并在 `config.toml` 中开启 `enablePWA`
在前置参数中设置 `type: offline`,并在 `hugo.toml` 中开启 `enablePWA`

```toml
[params]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -481,7 +481,7 @@ Head to the [Theme Configuration | Mermaid][mermaid-theming] page to learn more

### Site-wide Themes

You can configure mermaid themes globally in `config.toml` via the `params.mermaid` parameter.
You can configure mermaid themes globally in `hugo.toml` via the `params.mermaid` parameter.

### Diagram-specific Themes

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -482,7 +482,7 @@ Mermaid 的 C4 图语法与 PlantUML 兼容。以下是示例:

### 站点范围主题

您可以通过 `config.toml` 中的 `params.mermaid` 参数全局配置 Mermaid 主题。
您可以通过 `hugo.toml` 中的 `params.mermaid` 参数全局配置 Mermaid 主题。

### 图表特定主题

Expand Down
2 changes: 1 addition & 1 deletion content/guides/pwa-support/index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ type: "offline"

### Enable the `enablePWA` option {#enable-pwa}

Go to `config.toml`, add or change the option `enablePWA = true` under `[params]`.
Go to `hugo.toml`, add or change the option `enablePWA = true` under `[params]`.

```toml
[params]
Expand Down
2 changes: 1 addition & 1 deletion content/guides/pwa-support/index.zh-cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ type: "offline"

### 开启 `enablePWA` 选项 {#enable-pwa}

前往 `config.toml`, 添加/修改 `[params]` 配置项下 `enablePWA` 选项的值为 `true`
前往 `hugo.toml`, 添加/修改 `[params]` 配置项下 `enablePWA` 选项的值为 `true`

```toml
[params]
Expand Down

0 comments on commit 9042634

Please sign in to comment.