千家信息网

如何理解vitepress以及怎么将vuepress升为vitepress

发表于:2026-11-02 作者:千家信息网编辑
千家信息网最后更新 2026年11月02日,如何理解vitepress以及怎么将vuepress升为vitepress,很多新手对此不是很清楚,为了帮助大家解决这个难题,下面小编将为大家详细讲解,有这方面需求的人可以来学习下,希望你能有所收获。
千家信息网最后更新 2026年11月02日如何理解vitepress以及怎么将vuepress升为vitepress

如何理解vitepress以及怎么将vuepress升为vitepress,很多新手对此不是很清楚,为了帮助大家解决这个难题,下面小编将为大家详细讲解,有这方面需求的人可以来学习下,希望你能有所收获。

在vue3之前相信大家都用过或者听过vuepress,它是一个基于vue的静态网站生成器,可以用来写文档的。具体内容可以看VuePress官网。

但是现在有了vue3,也有了vite,然后就有了一个建立在vite之上的vitepress。(vitepress产生的动机可以去看官网,有说明)。

vitepress的优势

  • 基于vite而不是webpack,所有更快的启动时间,热重载等

  • 使用vue3来减少js的有效负载

.vitepress/config.js

vitepress改进的地方

用了vue3

  • 利用了vue3的改进的模板静态分析来尽可能字符串化静态内容

  • 使用了vite

    • 更快的dev服务启动

    • 热更新更快

    • 构建更快(使用了Rollup)

更轻量的页面

  • vue 3 树摇 + Rollup 代码分离

  • 不会把所有页面的元数据都在一个请求中发送出去。客户端导航时再一起获得新页面的组件及元数据

  • 没有用vue-router

  • (WIP)i18n本地化数据根据需要请求

不同点

  • vitepress少的配置。vitepress目标是所减掉当前vuepress的复杂性并从极简主义的根源重新开始

  • 是面向未来的:其目标浏览器是只支持原生ES模块导入的浏览器。鼓励使用原生的js而不是用转义以及使用css变量来主体化

升级过程

以下使用的vitepress是v0.20.0的版本

1、安装vitepress

npm install vitepress

原来在使用vuepress的时候肯定会有一个docs文件夹(如果没有的话就可以自己创建一个)。

2、更改入口文件为index.md

注意:vuepress的入口文件是docs/readme.md,而vitepress的入口文件是index.md,所以这个地方要改一下原来readme的名字如果index.md没有其他内容,可以添加一些简单内容

---home: truetitle: 主页lang: en-USheroText: BIFE文档库tagline: 这是你的舞台,期待你的精彩actionText: Get StartedactionLink: /新人须知/first-dayfooter: MIT Licensed | Copyright © 2021-present CoolDream---

3、配置vitepress信息

  • 创建.vitepress文件夹

  • 在.vitepress下创建配置文件config.js

  • 在config.js中添加配置信息

export default {    base: '', // 项目的基础路径    title: '文档', // 文档的标题,会显示在    description: '前端技术文档', // 文档描述    lastUpdated: '上次更新时间', // string | boolean}

4、如果想要添加顶部的右侧导航,可以在themeConfig中添加

module.exports = {    themeConfig: {        // 顶部右侧导航        nav: [            { text: 'Home', link: '/first-day' },            {                text: 'Components',                link: '/test'            },        ],    }}

注意:nav中的导航链接需要跟链接的文件名字一致,区分大小写

5、添加左侧导航,也是在themeConfig中添加

需要注意

vuepress的链接children中是具体的链接,而显示的导航名称是每一个.md文件中的title

而vitepress的children中是一个对象数组,text表示导航名称,link才是真正的链接

如果有多个路由的话,一定要把默认的路由写在最后

module.exports = {    themeConfig: {        // 侧边栏        sidebar: [            '/CHANGLOG':[                {                    text: '更新日志'                }            ],            '/': [                {                    text: '新人须知',                    children: [                        {                          text: '入职第一天',                          link: '/first-day'                        },                        {                            text: '入职第一周',                            link: '/first-week'                        }                     ]                 }             ]        ],            }}

6、添加脚本到package.json中

"scripts": {    "dev": "vitepress dev docs",    "build": "vitepress build docs",    "notice": "sh scripts/notice.sh" },

7、卸载vuepress

npm uninstall vuepress

升级中遇到的问题

多个路由切换的时候不生效

最初的时候把默认路由写在了最前面,发现切换路由的时候路由没有更新,还是默认的路由,后来发现需要把默认路由写在最后

themeConfig:{    // 侧边栏    sidebar: {        // 其他路由在前        'other-router':[],        // 默认路由在最后        '/': [            {                text: '新人须知',                children: [                    {                      text: '入职第一天',                      children: [                          {text: '电脑'}                      ]                    }                ]            }        ]     }}

markdown中table格式(build的时候会报错)

数据类型后不能要空格,报错的行数一点都对不上,导致找问题找了好久),具体如下图

文件内部链接路径一定是.md或者省略,不能是其他文件类型(build的时候会报错)

vitepress会把路径的最后一级路径转换为*.html(如果是以/结尾的话,回去找文件夹下的index.md),如果是其他文件类型,如果*.txt,会导致找不到文件

markdown内部的链接不能包含有中文(build的时候会报错)

如果在markdown中有这样的链接格式[技术分享](/技术分享/WebComponents/),在npm run build的时候是会报错的,报错信息如下图,此时改用标签链接就行

markdown中的链接需要http协议(build的时候会报错)

看完上述内容是否对您有帮助呢?如果还想对相关知识有进一步的了解或阅读更多相关文章,请关注行业资讯频道,感谢您对的支持。

文件 路由 链接 时候 导航 文档 内容 会报 数据 更快 路径 更新 配置 信息 入口 技术 文件夹 新人 类型 静态 数据库的安全要保护哪些东西 数据库安全各自的含义是什么 生产安全数据库录入 数据库的安全性及管理 数据库安全策略包含哪些 海淀数据库安全审计系统 建立农村房屋安全信息数据库 易用的数据库客户端支持安全管理 连接数据库失败ssl安全错误 数据库的锁怎样保障安全 互联网科技公司简介 互联网是第几次科技革命的成果 涨乐互联网科技 互联网下的科技发展 万易互联网科技 互联网金融科技创新 互联网金融科技平台 融贸通互联网科技 衡水科技产业互联网平台 海南科技产业互联网平台 雨阳互联网卡科技有限公司 广州百诚互联网科技有限公司官网 张召忠谈中国互联网科技 互联网硬科技公司 美国五大互联网科技公司市值多少 广西泛欧互联网科技有限公司 互联网科技对化妆品行业 互联网科技大会大佬 科技互联网专业务虚会材料 瑞安市蟠桃会互联网科技有限公司 百单网互联网科技有限公司 广东万易互联网科技有限公司惠州分公司 上海亿帐通互联网科技 互联网科技热点资讯 知域互联网科技有限公司大骗子 互联网保险科技创业 广州千川互联网科技有限公司 广东鹅鹅鹅互联网科技有限公司 平安好医生打造互联网科技医疗 上海互联网科技园景观
0