Cood Book（参考）

安装

1
cnpm i docsify-cli -g

初始化

1
docsify init ./

目录

1
2
3
4
5
index.html 入口配置文件

README.md 主页渲染内容

.nojekyll 阻止GitHub Pages 会忽略掉下划线开头的文件

预览

1
2
3
docsify serve ./

http://localhost:3000/

index.html

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
window.$docsify = {
    name: 'Coode Book',
        repo: '',//右上角挂件
        coverpage: true,//开启封面
        onlyCover: true, //首页只显示封面
        maxLevel: 3,//最大支持渲染的标题层级
        subMaxLevel: 2,
        homepage: 'README.md',
        loadSidebar: true,//侧边栏
        loadNavbar: true,//导航栏
        auto2top: true,//切换页面后是否自动跳转到页面顶部
        //全文搜索
        search: {
            maxAge: 86400000, // 过期时间，单位毫秒，默认一天
            paths: 'auto',
            placeholder: '搜索',
            noData: '找不到结果',
            // 搜索标题的最大程级, 1 - 6
            depth: 3,
        },
}

_coverpage.md

1
2
3
4
5
6
7
8
9
10

![logo](https://docsify.js.org/_media/icon.svg)

# Code Book

> 日常总结笔记文档

* java、 Vue 、Linux

[Quick Start](README.md)

关于目录层级

docsify用来做文档真是简单舒适，但做多层目录的没看到几个，先用比较麻烦的方法做下，后面看到好的再换

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
.
├──docs
|   ├── A
|   ├── B
|   |   ├── B-1
|   |   |  ├── a.md
|   |   |  └── b.md
|   |   ├── B-2
|   |   ├── README.md 
|   |   └── _sidebar.md 子页目录
|   └── Linux
├── _navbar.md 导航栏
├── _sidebar.md 首页目录
├── .nojekyll
├── README.md 
└── index.html

首页目录中设置
* [A](./docs/A/README.md)
* [B](./docs/B/README.md)

子页目录中设置
* [B-1](./docs/B/README.md)
    * [a](./docs/B/B-1/a.md)
    * [b](./docs/B/B-1/b.md)
* [B-2](./docs/B/README.md)

demo