# 使用规范

开发中经常会听到“约定优于配置”，因此在这里提供一些约定的配置，来帮你快速打造一个本主题样式的网站。

# 导航栏配置

1、头部导航栏链接使用Link值作为key来判断导航路由，因此导航栏配置请不要出现相同的link值。

2、本主题导航栏支持下拉菜单，但是一般不建议您嵌套超过三层的路由。

module.export = {
    
    ...
    themeConfig: {

    }

    nav: [
        { text: '指南', link: '/install/' },
        { text: '案例', link: '/example/' },
        { 
            text: '案例', 
            link: '/example/',
            items: [
                {text: 'nav1', link: '/example/nav1/'},
                 {text: 'nav1', link: '/example/nav1/'}
            ]
        },
    ],
    ...
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

# 侧边栏配置

1、侧边栏分组配置，建议参考如下配置，关闭collapsable、并将sidebar深度改为0

modules.export = {
    ...
    themeConfig: {
        ...
        sidebar: {
            "/install/": [{
                    title: '上手指南', // 必要的
                    collapsable: false, // 可选的, 默认值是 true,建议改为false
                    sidebarDepth: 0, // 可选的, 默认值是 1，建议改为0
                    children: [
                        '',
                        '扩展配置',
                        '使用规范',
                        '怎样记笔记',
                        '自由定制',
                        '贡献指南',
                        'CHANGELOG',
                    ]
                },
                {
                    title: '插件配置',
                    collapsable: false,
                    sidebarDepth: 0,
                    children: [
                        'mediumZoom',
                        'lastUpdated',
                        'nprogress',
                        'search'
                    ]
                }
            ],
        }
        ...
    }
    ...
}

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
27
28
29
30
31
32
33
34
35
36

# 首页配置

1、首页的frontmatter信息建议配置action，但是不要超过4个

2、首页的features建议不要超过3个

---
actions:
- text: 快速上手 →
  link: /install/
- text: 配置
  link: /config/


features: 
- title: SCSS 预处理器
  details: 默认支持Stylus和Scss的样式，使用Sass的预处理器。
- title: Animated 动画支持
  details: 主题增加了对Animate 动画的支持，让交互更顺滑。
- title: 功能增强优化
  details: 新增多个action按钮，优化各种显示效果和动画，同时加载速度接近默认主题，专为写笔记诞生。

footer: MIT Licensed | Copyright © 2020-present JackRay-c
---

Content

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# 页面配置

1、对于每个文件，建议在frontmatter上添加title信息，这有助于页面信息、侧边栏名称的生成。

---
title: 页面标题
---

1
2
3

# 主题配置

# 插件配置

上次更新: 5/2/2020, 11:26:22 PM

扩展配置关于笔记