Skip to content

基本配置

  • .vitepress文件夹下面的config.mts是我们的主要配置文件,大多的配置都要在这里进行修改,可以修改针对浏览器标题等信息的描述等等

  • index.md是我们网站的首页,首页的信息都可以在这里进行修改

  • 初始化时,还会有两个文档案例,删掉即可,后续一般是创建文件夹来存放我们的文档,方便进行管理

    创建docs文件夹进行.md文件的管理,同时需要在配置文件config.mts中进行添加配置:srcDir: "./docs/",,这句代码的本质意思就是将根目录设置成了docs文件夹

    配置完后,后续我们就可以在docs文件夹中放我们的.md文档了

config.mts配置文件中的themeConfig中进行配置网页的logo

ts
themeConfig: {
    logo: '/logo.svg',
}

同时我们需要在docs根目录下新建一个pubilc文件夹,用于存放我们的logo图片


文档定制

文档的定制主要涉及到两个方面,第一个部分是右上方的导航栏,另一部分是左侧的侧边栏

导航栏在config.mts中的体现是nav配置项,但是我们一般要将导航栏的配置移除config配置文件,采用引入的方式进行导入,防止配置文件过于杂乱,一般在.vitepress文件下创建nav.ts文件,其内容为:

ts
export default [
    { text: 'Home', link: '/' },
    // 可以进行嵌套,使其有子菜单
    { 
        text: '前端',
        items: [
            { text: 'html', link: '/html/基础知识' },
        ]
    }
]

我们需要在config.mts文件中将其引入进来:import nav from './nav'

侧边栏同理,我们也应该将其抽离出去,单独写成sidebar.ts文件,使配置文件更加简洁

侧边栏是用于同一个文件(笔记)具体章节的跳转的,基本配置如下:

ts
export default {
    '/html/': [
        {
            text: 'html',
            items: [
                { text: '基础知识', link: '/html/基础知识' },
                { text: '其他知识', link: '/html/其他知识' },
            ]
        }
    ]
}

站内搜索

我们可以在配置文件config.mts中添加启用本地搜索:

ts
themeConfig: {
    search: {
        provider: 'local'
    },
}

搜索是搜索静态内容,搜索到关键词所在的标题段落

Released under the MIT License.