Skip to content

Latest commit

 

History

History
99 lines (64 loc) · 4.65 KB

README.md

File metadata and controls

99 lines (64 loc) · 4.65 KB
Raw

hugo-theme-even

GitHub contributors GitHub release GitHub commits (since latest release) GitHub

A super concise theme for Hugo

It's a port of the hexo-theme-even

Demo | 中文说明

Screenshots

even-showcase

Installation

$ git clone https://github.com/olOwOlo/hugo-theme-even themes/even

Important: Take a look inside the exampleSite folder of this theme. You'll find a file called config.toml. To use it, copy the config.toml in the root folder of your Hugo site. Feel free to change it.

NOTE: For this theme, you should use post instead of posts, namely hugo new post/some-content.md.

Language Support

Translations are collected from the themes/even/i18n/ folder (built into the theme), as well as translations present in i18n/ at the root of your project. The translations will be merged and take precedence over what is in the theme folder.

To use the translations, just set a correct value for defaultContentLanguage.

defaultContentLanguage = "en"  # en / zh-cn / other...

Can also support any other languages as well. For example, to support german, create a file /i18n/de.yaml in the root folder of your Hugo site. For reference template you can see the en.yaml file.

P.S. In multilingual mode, the language which currently being used to render the website will be used.

Favicon

In order to customize the favicon you need to place all the following files in the static folder at the root of your site, which will overwrite those files in the themes/even/static/ folder.

  • 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

A favicon generator can help you generate these files.

Front Matter

You can customize something for a single content in the content's front-matter. The themes/even/archetypes/default.md shows all available params. Copy this file in the archetypes folder at the root of your project will be useful.

Shortcodes

This theme provides center, right, left, music, admonition shortcodes, and support center, right, left class for the built-in figure. See more information from there.

Theme Color

There are five built-in theme colors ( Default | Mint Green | Cobalt Blue | Hot Pink | Dark Violet ), you can config it by changing the $theme-color-config value in /src/css/_variable.scss.

Build

If you changed any file under /src/, you need to rebuild.

cd ./themes/even/
# install dependencies
yarn install
# build
yarn build

You need to install Yarn and Node.js first.

Update Theme

cd ./themes/even/
git pull

License

Released under the MIT License.

Acknowledgements