From 41e7ef6863315988e940b80a0c0b1bcd649736f4 Mon Sep 17 00:00:00 2001 From: "qingwei.li" Date: Fri, 30 Dec 2016 18:09:13 +0800 Subject: [PATCH] Add docs --- docs/README.md | 12 ++++++++++++ docs/zh-cn.md | 12 ++++++++++++ 2 files changed, 24 insertions(+) diff --git a/docs/README.md b/docs/README.md index 2513e46f..9c5752c8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -201,6 +201,18 @@ The contents of the file can be: - [HTML5 History Mode](/history-mode) ``` +#### max-sub-level + +Display TOC in the custom sidebar. The default value is 0. + + +```html + +``` + +![image](https://cloud.githubusercontent.com/assets/7565692/21563209/a8894512-ceba-11e6-80eb-fef00b80625c.png) + + #### load-navbar Load navbar markdown file. If it is configured, load the current directory `_navbar.md` by default. diff --git a/docs/zh-cn.md b/docs/zh-cn.md index bf9295dc..84442e99 100644 --- a/docs/zh-cn.md +++ b/docs/zh-cn.md @@ -206,6 +206,18 @@ Sidebar 开关按钮 - [HTML5 History Mode](/history-mode) ``` +#### max-sub-level + +显示 TOC 在自定义的侧边栏里,默认最大显示 0 层。 + + +```html + +``` + +![image](https://cloud.githubusercontent.com/assets/7565692/21563209/a8894512-ceba-11e6-80eb-fef00b80625c.png) + + #### load-navbar 读取导航配置文件,如果配置,默认加载当前目录下的 `_navbar.md`。如果文件不存在,会显示 html 里定义的导航栏。