diff options
Diffstat (limited to 'README-zh.md')
| -rw-r--r-- | README-zh.md | 64 |
1 files changed, 47 insertions, 17 deletions
diff --git a/README-zh.md b/README-zh.md index 30845fd..ccd60b6 100644 --- a/README-zh.md +++ b/README-zh.md @@ -10,43 +10,73 @@ A super concise theme for Hugo  -## Feature - -- 响应式 -- 支持 Fancybox -- 版权信息，自定义许可协议 -- 文章打赏，添加二维码 -- 代码高亮显示 -- mathjax - ## Installation ```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 +## Language Support + +> 翻译资源在 [`themes/even/i18n/`](https://github.com/olOwOlo/hugo-theme-even/tree/master/i18n) 文件夹（内置在主题中），以及站点根目录下的 `i18n/` 文件夹中。两个文件夹下的翻译资源将会被合并，且根目录下的优先级大于内置于主题中的。 + +只需要正确的设置 [`defaultContentLanguage`](https://github.com/olOwOlo/hugo-theme-even/blob/master/exampleSite/config.toml#L3) 的值即可使用翻译资源。 + +```toml +defaultContentLanguage = "en" # en / zh-cn / other... +``` + +同样也支持其他语言。举例来说，为支持德语，在站点根目录下创建 `/i18n/de.yaml` 文件。参考 [`en.yaml`](https://github.com/olOwOlo/hugo-theme-even/tree/master/i18n/en.yaml) 文件查看如何编写翻译资源。 + +附：在多语言模式下，当前正被用于渲染网站的语言会被用于匹配翻译资源。 -- **favicon.ico:** 将你的 favicon.ico 放置在 `/static` 目录下即可，支持 apple-touch-icon、32x32、16x16、manifest.json、safari-pinned-tab.svg +## Favicon -- **Front matter:** 将主题目录下 `archetypes` 中的 `default.md` 文件复制到你的 `archetypes` 目录下。 +为了定制 favicon，你需要在站点根目录的 `static` 文件夹下放置下述**所有**文件，这将覆盖 [`themes/even/static/`](https://github.com/olOwOlo/hugo-theme-even/tree/master/static) 文件夹下的那些文件。 -- **Language:** 语言文件在 [`/themes/even/data/even/`](https://github.com/olOwOlo/hugo-theme-even/tree/master/data/even) 目录下。在你的 `data` 目录下创建一个 `even` 目录并复制 `default.toml` 文件到你的 `/data/even/` 目录下，之后你可以按照自己需求更改它。 +- android-chrome-192x192.png +- android-chrome-512x512.png +- apple-touch-icon.png +- browserconfig.xml +- favicon.ico +- favicon-16x16.png +- favicon-32x32.png +- manifest.json +- mstile-150x150.png +- safari-pinned-tab.svg -- **Theme color:** Default | Mint Green | Cobalt Blue | Hot Pink | Dark Violet +[favicon generator (Google)](https://www.google.com/search?q=favicon+generator) 能够帮助你生成这些文件。 - 主题预置了上述五种颜色，你可以通过更改 `/src/css/_variable.scss` 文件中 `$theme-color-config` 的值来改变主题的颜色。 +## Front Matter + +你可以通过 front-matter 针对每一篇文章单独进行设置。[`themes/even/archetypes/default.md`](https://github.com/olOwOlo/hugo-theme-even/tree/master/archetypes/default.md) 文件陈列了所有可用的参数。将该文件复制到站点根目录的 `archetypes` 文件夹下将会有所帮助。 + +## Shortcodes + +主题提供了 `center`,` right`, `left`,` music` 四种 shortcodes，并支持为内置的 `figure` 设置 `center`,` right`, `left` 这三种 class 值。点击[这里](https://blog.olowolo.com/example-site/post/shortcodes/)查看详细内容。 + +## Theme Color + +主题内置了五种颜色 ( Default | Mint Green | Cobalt Blue | Hot Pink | Dark Violet )，你可以通过改变 [`/src/css/_variable.scss`](https://github.com/olOwOlo/hugo-theme-even/blob/master/src/css/_variables.scss#L5-L8) 文件中 `$theme-color-config` 的值来改变主题的颜色。 -### Build +## Build -如果你更改了 `/src/` 目录下的任意文件，你需要重新编译它们。 +如果你更改了 `/src/` 目录下的任意文件，你需要重新编译它们。 ```bash cd ./themes/even/src/ npm install npm run build ``` +## Update Theme + +```bash +cd ./themes/even/ +git pull +``` + ## License Released under the [MIT](https://github.com/olOwOlo/hugo-theme-even/blob/master/LICENSE.md) License. |