vuepress----1、快速开始

创建项目工程

本文会帮助你从头搭建一个简单的 VuePress 文档。如果你想在一个现有项目中使用 VuePress 管理文档,从步骤 3 开始。

  1. 创建并进入一个新目录

    bash 复制代码
    mkdir vuepress-starter && cd vuepress-starter
  2. 使用你喜欢的包管理器进行初始化

    bash 复制代码
    yarn init # npm init
  3. 将 VuePress 安装为本地依赖

    我们已经不再推荐全局安装 VuePress

    bash 复制代码
    yarn add -D vuepress # npm install -D vuepress

    注意

    如果你的现有项目依赖了 webpack 3.x,我们推荐使用 Yarn (opens new window)而不是 npm 来安装 VuePress。因为在这种情形下,npm 会生成错误的依赖树。

  4. 创建你的第一篇文档

    bash 复制代码
    mkdir docs && echo '# Hello VuePress' > docs/README.md
  5. package.json 中添加一些 scripts(opens new window)

    这一步骤是可选的,但我们推荐你完成它。在下文中,我们会默认这些 scripts 已经被添加。

    json 复制代码
    {
      "scripts": {
        "docs:dev": "vuepress dev docs",
        "docs:build": "vuepress build docs"
      }
    }
  6. 在本地启动服务器

    bash 复制代码
    yarn docs:dev # npm run docs:dev

    VuePress 会在 http://localhost:8080 (opens new window)启动一个热重载的开发服务器。

相关推荐
百锦再10 分钟前
React编程高级主题:错误处理(Error Handling)
前端·javascript·react.js·前端框架·vue·web·angular
跟着珅聪学java1 天前
spring boot +Elment UI 上传文件教程
java·spring boot·后端·ui·elementui·vue
杉之2 天前
常见前端GET请求以及对应的Spring后端接收接口写法
java·前端·后端·spring·vue
剑亦未配妥2 天前
Vue2函数式组件实战:手写可调用的动态组件,适用于toast轻提示、tip提示、dialog弹窗等
前端·vue.js·vue
wuaro3 天前
RBAC权限控制具体实现
前端·javascript·vue
前端互助会4 天前
AILabel标注工具指南(二):禁止图片外标注
vue·ailabel
YiHanXii5 天前
Axios 相关的面试题
前端·http·vue·react
申朝先生6 天前
vueRouter的hash模式跟history的区别
vue
小阳生煎6 天前
Vue3当中el-tree树形控件使用
vue