docs: update navigation

dangchienhsgs · Jul 7, 2018 · 96d21c2 · 96d21c2
1 parent 79bd285
commit 96d21c2
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 2 deletions.
diff --git a/docs/en/2.2-navigation.md b/docs/en/2.2-navigation.md
@@ -34,4 +34,33 @@ header:
     url:        https://github.com/kitian616/jekyll-TeXt-theme
 ```
 
-You can use `titles` for a multi-language name.
+You can use `titles` for a multi-language name.
+
+## Sidebar Navigation
+
+To use sidebar navigation, you should first defined a navigation iin *data/navigation.yml*.
+
+```yaml
+docs-en:
+  - title:      Start
+    children:
+      - title:  Quick Start
+        url:    /docs/en/quick-start
+      - title:  Structure
+        url:    /docs/en/structure
+      ...
+  - title:      Customization
+    children:
+      - title:  Configuration
+        url:    /docs/en/configuration
+      - title:  Navigation
+        url:    /docs/en/navigation
+      ...
+```
+
+And then use the defined navigation as article's sidebar navigation in the Front Matter:
+
+```yaml
+sidebar:
+  nav: docs-en
+```
diff --git a/docs/zh/2.2-navigation.md b/docs/zh/2.2-navigation.md
@@ -34,4 +34,33 @@ header:
     url:        https://github.com/kitian616/jekyll-TeXt-theme
 ```
 
-你可以用 `titles` 来定义一个支持多语言的标题名。
+你可以用 `titles` 来定义一个支持多语言的标题名。
+
+## 侧边栏导航栏
+
+要想在某篇文章或页面中使用侧边栏导航栏，首先你需要在 *data/navigation.yml* 中定义一个导航栏。
+
+```yaml
+docs-en:
+  - title:      Start
+    children:
+      - title:  Quick Start
+        url:    /docs/en/quick-start
+      - title:  Structure
+        url:    /docs/en/structure
+      ...
+  - title:      Customization
+    children:
+      - title:  Configuration
+        url:    /docs/en/configuration
+      - title:  Navigation
+        url:    /docs/en/navigation
+      ...
+```
+
+然后在头信息中将定义的导航作为这篇文章或页面的侧边栏导航栏：
+
+```yaml
+sidebar:
+  nav: docs-en
+```