mirror of https://git.adityakumar.xyz/hugo-theme-even.git synced 2024-11-21 19:42:52 +00:00

A super concise theme for Hugo

Find a file

Egor Lynko fcf2021958 feat(language-selector): Implement optional language selector (#298 )		2021-01-17 22:32:33 +08:00
.github	chore(github): enable stale app	2021-01-17 22:18:42 +08:00
archetypes	feat(post): add out-of-date content warning (#68 )	2018-06-01 00:06:14 +08:00
assets	feat(language-selector): Implement optional language selector (#298 )	2021-01-17 22:32:33 +08:00
exampleSite	feat(language-selector): Implement optional language selector (#298 )	2021-01-17 22:32:33 +08:00
i18n	feat(i18n): Adding Turkish translations (#328 )	2021-01-17 21:19:46 +08:00
images	docs: add showcase image, change default qrcode image	2017-09-13 00:25:59 +08:00
layouts	feat(language-selector): Implement optional language selector (#298 )	2021-01-17 22:32:33 +08:00
resources/_gen/assets/scss/sass	fix(layouts): add missing space for minify (#250 )	2020-09-11 00:02:51 +08:00
static	chore(static/dist): remove unused files	2020-04-16 00:53:21 +08:00
.gitignore	chore(.gitignore): remove .gitignore entries not needed anymore (#246 )	2020-04-20 02:09:00 +08:00
CHANGELOG.md	chore(CHANGELOG.md): make final conservative release	2021-01-17 22:03:48 +08:00
LICENSE.md	🎉 first commit	2017-08-27 22:38:42 +08:00
Makefile	chore(CHANGELOG.md): make final conservative release	2021-01-17 22:03:48 +08:00
netlify.toml	chore(netlify.toml): init configuration file	2020-08-03 02:16:53 +08:00
README-zh.md	chore(CHANGELOG.md): make final conservative release	2021-01-17 22:03:48 +08:00
README.md	feat(language-selector): Implement optional language selector (#298 )	2021-01-17 22:32:33 +08:00
theme.toml	chore(hugo): min version 0.60.0	2020-04-16 20:47:16 +08:00

README.md

hugo-theme-even

A super concise theme for Hugo

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

Demo | 中文说明

Screenshots

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.

Important: This theme uses Hugo Pipes. Modifying contents in assets requires the extended version to be installed.

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.

Language selector

It is possible to enable language selector for multilingual site. It will be displayed in the header or in the slide menu.

To enable it, set showLanguageSelector parameter to true.

showLanguageSelector = true

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 /assets/sass/_variable.scss.

Update Theme

cd ./themes/even/
git pull

Whenever you update this theme, you should check the CHANGELOG.md file, there may be some breaking changes.

License

Released under the MIT License.