Explorar el Código

修改编写说明

leosmilence@163.com hace 4 años
padre
commit
e109457f00
Se han modificado 1 ficheros con 33 adiciones y 0 borrados
  1. 33 0
      README.md

+ 33 - 0
README.md

@@ -12,6 +12,39 @@
 cnpm install
 ```
 
+### 书写编辑
+
+**添加新章节的操作步骤**
+
+1. 在 docs/category/ 文件夹下新建一个 article-5.md 文件(文件命名只会在配置文件中用到,不会在界面上展示,可以自由选择)
+
+在每个md 文件开头写每章的标题,如下:
+
+```
+---
+title : 左侧目录的标题
+---
+```
+
+2. 每个md 文件中的 一二级标记及 # ## 都会自动生成目录
+
+3. 配置到左侧目录上
+需要修改 docs/category/sidebar_contents.js 配置文件
+
+```diff
+module.exports = [
+	"/category/",
+	"git",
+	"interface",
+	"cache",
+	"article-1",
+	"article-2",
+	"article-3",
+	"article-4",
++	"article-5",
+];
+```
+
 ### 启动生成
 ```
 npm run dev // 开发调试