Skip to content

快速搭建

当我们需要搭建属于自己的在线文档库时,我们可以使用VitePress进行在线文档网站的快速搭建

使用VitePress进行在线文档的快速搭建:

  1. 在指定的文档下运行cmd操作
  2. npm add -D vitepress
  3. npx vitepress init
  4. 后续全部回车即可

默认情况下通过npm run docs:dev运行项目,在package.json文件中的配置如下:

json
{
  "devDependencies": {
    "vitepress": "^1.5.0"
  },
  "scripts": {
    "docs:dev": "vitepress dev",
    "docs:build": "vitepress build",
    "docs:preview": "vitepress preview"
  }
}

如果我们觉得"docs:dev"的形式太过繁琐,我们可以将其修改为类似于vue的模式:

json
{
  "devDependencies": {
    "vitepress": "^1.5.0"
  },
  "scripts": {
    "dev": "vitepress dev",
    "build": "vitepress build",
    "preview": "vitepress preview"
  }
}

后续就可以通过npm run dev来启动本地项目

Released under the MIT License.