mirror of
https://git.adityakumar.xyz/hugo-theme-even.git
synced 2024-11-08 22:49:44 +00:00
88 lines
4.4 KiB
Markdown
88 lines
4.4 KiB
Markdown
# hugo-theme-even
|
||
|
||
[](https://github.com/olOwOlo/hugo-theme-even/contributors)
|
||
[](https://github.com/olOwOlo/hugo-theme-even/releases)
|
||
[](https://github.com/olOwOlo/hugo-theme-even/compare)
|
||
[](https://github.com/olOwOlo/hugo-theme-even/blob/master/LICENSE.md)
|
||
|
||
A super concise theme for Hugo
|
||
|
||
> 该主题移植自 [hexo-theme-even](https://github.com/ahonn/hexo-theme-even)
|
||
|
||
[在线预览 Demo](https://hugo-theme-even.netlify.app)
|
||
|
||
## Screenshots
|
||
|
||
|
||
|
||
## 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) 文件复制到你的站点目录下**，根据自己的需求更改即可。
|
||
|
||
**重要:** 本主题用到了 [Hugo Pipes](https://gohugo.io/hugo-pipes/introduction/) 功能。如需修改 `assets` 目录下的文件，请安装 extended 版。
|
||
|
||
**注意:** 对于这个主题，你应该使用 **post** 而不是 **posts**，即 `hugo new post/some-content.md`。
|
||
|
||
## 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
|
||
|
||
为了定制 favicon，你需要在站点根目录的 `static` 文件夹下放置下述**所有**文件，这将覆盖 [`themes/even/static/`](https://github.com/olOwOlo/hugo-theme-even/tree/master/static) 文件夹下的那些文件。
|
||
|
||
- 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
|
||
|
||
[favicon generator (Google)](https://www.google.com/search?q=favicon+generator) 能够帮助你生成这些文件。
|
||
|
||
## 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`, `admonition` 这些 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 )，你可以通过改变 [`/assets/sass/_variable.scss`](https://github.com/olOwOlo/hugo-theme-even/blob/master/assets/sass/_variables.scss#L5-L8) 文件中 `$theme-color-config` 的值来改变主题的颜色。
|
||
|
||
## 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.
|
||
|
||
## Acknowledgements
|
||
|
||
- [ananke](https://github.com/budparr/gohugo-theme-ananke)
|
||
- [hexo-theme-even](https://github.com/ahonn/hexo-theme-even)
|
||
- [hugo-nuo](https://github.com/laozhu/hugo-nuo)
|