diff options
| author | olOwOlo <26087907+olOwOlo@users.noreply.github.com> | 2018-01-24 00:48:55 +0800 |
|---|---|---|
| committer | olOwOlo <26087907+olOwOlo@users.noreply.github.com> | 2018-01-24 00:48:55 +0800 |
| commit | dcff1e389f0474bf01bdacbad6313fbdadab5329 (patch) | |
| tree | 691b187d887f6a05f6bb75fb2f84f2678de1e761 | |
| parent | 6f7bd1b933b2ed24569b90645510804b607ff428 (diff) | |
docs: don't forget copy the `config.toml`
| -rw-r--r-- | README-zh.md | 7 | ||||
| -rw-r--r-- | README.md | 10 |
2 files changed, 6 insertions, 11 deletions
diff --git a/README-zh.md b/README-zh.md index 19f8c12..30845fd 100644 --- a/README-zh.md +++ b/README-zh.md @@ -24,18 +24,15 @@ A super concise theme for Hugo ```bash $ git clone https://github.com/olOwOlo/hugo-theme-even themes/even ``` +**重要:** 在主题的 [`exampleSite`](https://github.com/olOwOlo/hugo-theme-even/tree/master/exampleSite) 目录下有一个 [`config.toml`](https://github.com/olOwOlo/hugo-theme-even/blob/master/exampleSite/config.toml) 文件，**将这个 [`config.toml`](https://github.com/olOwOlo/hugo-theme-even/blob/master/exampleSite/config.toml) 文件复制到你的站点目录下**，根据自己的需求更改即可。 ## Configuration -将 `exampleSite` 目录下的 `config.toml` 文件复制到你的站点目录下，根据自己的需求进行更改即可。 - -### More Configuration - - **favicon.ico:** 将你的 favicon.ico 放置在 `/static` 目录下即可，支持 apple-touch-icon、32x32、16x16、manifest.json、safari-pinned-tab.svg - **Front matter:** 将主题目录下 `archetypes` 中的 `default.md` 文件复制到你的 `archetypes` 目录下。 -- **Language:** 语言文件在 `/themes/even/data/even/` 目录下。在你的 `data` 目录下创建一个 `even` 目录并复制 `default.toml` 文件到你的 `/data/even/` 目录下，之后你可以按照自己需求更改它。 +- **Language:** 语言文件在 [`/themes/even/data/even/`](https://github.com/olOwOlo/hugo-theme-even/tree/master/data/even) 目录下。在你的 `data` 目录下创建一个 `even` 目录并复制 `default.toml` 文件到你的 `/data/even/` 目录下，之后你可以按照自己需求更改它。 - **Theme color:** Default | Mint Green | Cobalt Blue | Hot Pink | Dark Violet @@ -25,21 +25,19 @@ A super concise theme for Hugo $ git clone https://github.com/olOwOlo/hugo-theme-even themes/even ``` -## Configuration - -Copy the `config.toml` file from the `exampleSite` directory to your site directory and change it. +**Important:** Take a look inside the [`exampleSite`](https://github.com/olOwOlo/hugo-theme-even/tree/master/exampleSite) folder of this theme. You'll find a file called [`config.toml`](https://github.com/olOwOlo/hugo-theme-even/blob/master/exampleSite/config.toml). **To use it, copy the [`config.toml`](https://github.com/olOwOlo/hugo-theme-even/blob/master/exampleSite/config.toml) in the root folder of your Hugo site.** Feel free to change it. -### More Configuration +## Configuration - **favicon.ico:** Just put your favicon.ico under the `/static` directory if you want to change the default favicon.ico. - **Front matter:** Copy the `default.md` file from the `archetypes` directory to your `archetypes`. -- **Language:** Language files are under `/themes/even/data/even/` directory. Create a new directory `even` under your `data` directory and copy the `default.toml` to your `/data/even/`, and then you can change it if you want. +- **Language:** Language files are under [`/themes/even/data/even/`](https://github.com/olOwOlo/hugo-theme-even/tree/master/data/even) directory. Create a new directory `even` under your `data` directory and copy the `default.toml` to your `/data/even/`, and then you can change it if you want. - **Theme color:** Default | Mint Green | Cobalt Blue | Hot Pink | Dark Violet - You can config it by change the `$theme-color-config` value in `/src/css/_variable.scss`. + You can config it by changing the `$theme-color-config` value in `/src/css/_variable.scss`. ### Build |