Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/gundamew/hugo-bingo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBing-Sheng Chen <gundamew@gmail.com>2019-08-01 13:02:26 +0300
committerBing-Sheng Chen <gundamew@gmail.com>2019-08-01 13:02:26 +0300
commita9015e731ce16ad756e23b01a77b3ded03f336a6 (patch)
treef55e1d6a1dcf04f92be974e04bff17219fd0907e
parent5a27470a0cbb21aeec0ae016f761513678a8039a (diff)
docs(readme): Add language settings example
Fix "the content list page not found" bug and add multiple languages settings example to readme file.
-rw-r--r--README.md87
1 files changed, 86 insertions, 1 deletions
diff --git a/README.md b/README.md
index c925fed..b3e8202 100644
--- a/README.md
+++ b/README.md
@@ -15,7 +15,7 @@ $ git clone git@github.com:gundamew/hugo-bingo.git
For more information read the official guide: [Install and Use Themes](https://gohugo.io/themes/installing-and-using-themes/).
-## Usage
+## Features
### Use Google Analytics
@@ -98,6 +98,91 @@ Available social icons:
dateFormat = "2006-01-02"
```
+### Multiple languages
+
+Example config:
+
+```toml
+defaultContentLanguage = "zh"
+defaultContentLanguageInSubdir = true
+
+[languages]
+
+ [languages.en]
+ weight = 10
+ languageCode = "en-us"
+ languageName = "English"
+ contentDir = "content/en"
+
+ [languages.fr]
+ weight = 20
+ languageCode = "fr-fr"
+ languageName = "Français"
+ contentDir = "content/fr"
+
+ [languages.zh]
+ weight = 30
+ languageCode = "zh-tw"
+ languageName = "中文(臺灣)"
+ contentDir = "content/zh"
+
+[menu]
+
+ [[languages.en.menu.main]]
+ identifier = "home"
+ name = "Home"
+ url = "/"
+ weight = 10
+
+ [[languages.en.menu.main]]
+ identifier = "posts"
+ name = "Posts"
+ url = "/posts"
+ weight = 20
+
+ [[languages.fr.menu.main]]
+ identifier = "home"
+ name = "Maison"
+ url = "/fr"
+ weight = 10
+
+ [[languages.fr.menu.main]]
+ identifier = "posts"
+ name = "Des postes"
+ url = "/fr/posts"
+ weight = 20
+
+ [[languages.zh.menu.main]]
+ identifier = "home"
+ name = "首頁"
+ url = "/zh"
+ weight = 10
+
+ [[languages.zh.menu.main]]
+ identifier = "posts"
+ name = "文章列表"
+ url = "/zh/posts"
+ weight = 20
+```
+
+And you have organize your posts like this:
+
+```shell
+.
+└── content
+ └── en
+ | └── posts
+ | └── post-1.md
+ ├── fr
+ | └── posts
+ | ├── post-1.md
+ | └── post-2.md
+ └── zh
+ └── posts
+ ├── post-1.md
+ └── post-2.md
+```
+
## Built With
* [Highlight.js](https://highlightjs.org/)