快速上手 | VuePress
VuePress 指南 参考参考VuePress 命令行接口 配置 Frontmatter 内置组件 插件 API 主题 API 客户端 API Node API 打包工具 Vite Webpack 默认主题 配置 Frontmatter 内置组件 Markdown 样式 继承 插件插件常用功能 back-to-top container external-link-icon google-analytics medium-zoom nprogress register-components 内容搜索 docsearch search PWA pwa pwa-popup 语法高亮 prismjs shiki 主题开发 active-header-links git palette theme-data toc 了解更多了解更多深入 架构 开发插件 开发主题 Cookbook 其他资源 贡献指南 Awesome VuePress 在新窗口打开v2.0.0-rc.0v2.0.0-rc.0 更新日志 在新窗口打开 v1.x 在新窗口打开 v0.x 在新窗口打开选择语言选择语言 English 简体中文 GitHub 在新窗口打开搜索文档K 指南 参考参考VuePress 命令行接口 配置 Frontmatter 内置组件 插件 API 主题 API 客户端 API Node API 打包工具 Vite Webpack 默认主题 配置 Frontmatter 内置组件 Markdown 样式 继承 插件插件常用功能 back-to-top container external-link-icon google-analytics medium-zoom nprogress register-components 内容搜索 docsearch search PWA pwa pwa-popup 语法高亮 prismjs shiki 主题开发 active-header-links git palette theme-data toc 了解更多了解更多深入 架构 开发插件 开发主题 Cookbook 其他资源 贡献指南 Awesome VuePress 在新窗口打开v2.0.0-rc.0v2.0.0-rc.0 更新日志 在新窗口打开 v1.x 在新窗口打开 v0.x 在新窗口打开选择语言选择语言 English 简体中文 GitHub 在新窗口打开指南 介绍 快速上手 依赖环境 手动安装 配置 页面 Markdown 静态资源 多语言支持 部署 主题 插件 打包工具 从 v1 迁移 # 快速上手注意VuePress v2 目前仍处于 RC (Release Candidate) 阶段。你已经可以用它来构建你的站点，但是它的配置和 API 还不够稳定，有可能会发生一些微小的 Breaking Changes 。因此，在每次更新 RC 版本之后，请一定要仔细阅读 更新日志在新窗口打开。# 依赖环境Node.js v18.16.0+在新窗口打开包管理器，如 pnpm在新窗口打开、yarn在新窗口打开、npm在新窗口打开 等。提示使用 pnpm在新窗口打开 时，你需要安装 vue 和 @vuepress/client 作为 peer-dependencies 。使用 yarn 2+在新窗口打开 时，你需要在 .yarnrc.yml在新窗口打开 文件中设置 nodeLinker: 'node-modules' 。# 手动安装这一章节会帮助你从头搭建一个简单的 VuePress 文档网站。如果你想在一个现有项目中使用 VuePress 管理文档，从步骤 3 开始。步骤 1: 创建并进入一个新目录mkdir vuepress-starter
cd vuepress-starter
步骤 2: 初始化项目PNPMYARNNPMgit init
pnpm init
git init
yarn init
git init
npm init
步骤 3: 将 VuePress 安装为本地依赖PNPMYARNNPMpnpm add -D vuepress@next @vuepress/client@next vue
yarn add -D vuepress@next
npm install -D vuepress@next
步骤 4: 在 package.json 中添加一些 scripts在新窗口打开{
"scripts": {
"docs:dev": "vuepress dev docs",
"docs:build": "vuepress build docs"
步骤 5: 将默认的临时目录和缓存目录添加到 .gitignore 文件中echo 'node_modules' >> .gitignore
echo '.temp' >> .gitignore
echo '.cache' >> .gitignore
步骤 6: 创建你的第一篇文档mkdir docs
echo '# Hello VuePress' > docs/README.md
步骤 7: 在本地启动服务器来开发你的文档网站PNPMYARNNPMpnpm docs:dev
yarn docs:dev
npm run docs:dev
VuePress 会在 http://localhost:8080在新窗口打开 启动一个热重载的开发服务器。当你修改你的 Markdown 文件时，浏览器中的内容也会自动更新。现在，你应该已经有了一个简单可用的 VuePress 文档网站。接下来，了解一下 VuePress 配置 相关的内容。 在 GitHub 上编辑此页 在新窗口打开上次更新: 贡献者: meteorlxy, Mr.Hope, bleatingsheep 介绍 配置