aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorolOwOlo <26087907+olOwOlo@users.noreply.github.com>2018-02-01 21:35:04 +0800
committerolOwOlo <26087907+olOwOlo@users.noreply.github.com>2018-02-01 21:35:04 +0800
commitdf28365582e7b95666729a975924496124801732 (patch)
tree81fa947d843a292de27fb9610e1ae78e5a745898 /README.md
parent57c8a3adeaa00a603bb9059cdef0349bb61c1df1 (diff)
docs: update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md63
1 files changed, 46 insertions, 17 deletions
diff --git a/README.md b/README.md
index 54647c1..938a7d3 100644
--- a/README.md
+++ b/README.md
@@ -10,15 +10,6 @@ A super concise theme for Hugo
![even-showcase](https://raw.githubusercontent.com/olOwOlo/hugo-theme-even/master/images/showcase.png)
-## Feature
-
-- Responsive
-- Fancybox
-- Config license for content
-- highlight.js
-- Custom theme color
-- mathjax
-
## Installation
```bash
@@ -27,27 +18,65 @@ $ git clone https://github.com/olOwOlo/hugo-theme-even themes/even
**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.
-## Configuration
+## Language Support
+
+> Translations are collected from the [`themes/even/i18n/`](https://github.com/olOwOlo/hugo-theme-even/tree/master/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`](https://github.com/olOwOlo/hugo-theme-even/blob/master/exampleSite/config.toml#L3).
+
+```toml
+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`](https://github.com/olOwOlo/hugo-theme-even/tree/master/i18n/en.yaml) file.
+
+P.S. In multilingual mode, the language which currently being used to render the website will be used.
+
+## Favicon
-- **favicon.ico:** Just put your favicon.ico under the `/static` directory if you want to change the default favicon.ico.
+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/`](https://github.com/olOwOlo/hugo-theme-even/tree/master/static) folder.
-- **Front matter:** Copy the `default.md` file from the `archetypes` directory to your `archetypes`.
+- 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
-- **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.
+A [favicon generator](https://www.google.com/search?q=favicon+generator) can help you generate these files.
-- **Theme color:** Default | Mint Green | Cobalt Blue | Hot Pink | Dark Violet
+## Front Matter
- You can config it by changing the `$theme-color-config` value in `/src/css/_variable.scss`.
+You can customize something for a single content in the content's front-matter. The [`themes/even/archetypes/default.md`](https://github.com/olOwOlo/hugo-theme-even/tree/master/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` four shortcodes, and support `center`,` right`, `left` class for the built-in `figure`. See more information from [there](https://blog.olowolo.com/example-site/post/shortcodes/).
+
+## 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`](https://github.com/olOwOlo/hugo-theme-even/blob/master/src/css/_variables.scss#L5-L8).
-### Build
+## Build
-if you change any file under `/src/`, you need to rebuild.
+If you changed any file under `/src/`, you need to rebuild.
```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.