vuepress搭建静态网站

jiezi

5 年前

全局安装

npm install -g vuepress 或者 yarn global add vuepress

新建一个文件夹（例如 my-vuepress-test）

mkdir my-vuepress-test  (新建文件夹)

cd my my-vuepress-test  (切换至 my-vuepress-test 文件夹下)

npm init -y  (- y 表示使用默认方式创建 package.json)

打开自动生成的 package.json 文件，默认创建的文件如下：

{
  "name": "my-vuepress-test",
  "version": "1.0.0",
  "description": "","main":"index.js","scripts": {"test":"echo \"Error: no test specified\" && exit 1",},
  "author": "","license":"ISC","devDependencies": {"vuepress":"^1.0.3"}
}

然后在 scripts 属性中输入一下指令

 "docs:dev": "vuepress dev docs",（npm 脚本语句 启动服务）"docs:build": "vuepress build docs"（npm 脚本语句 编译打包输出 docs 文件夹里面的内容）

然后在 my-vuepress-test 夹中创建 docs 文件夹，然后在创建 README.md 文件(编译启动后默认展示文件)
```
//README.md 文件里面 随便输入一些内容 相当于 index.html 例如：# Hello VuePress 初次遇见
```

在刚创建的 docs 文件夹下在创建 .vuepress 文件夹，在这个文件下在创建 config.js 文件

// 在 config.js 输入下面的内容
module.exports = {
  title: 'vuePress', 
  description: 'this is static web site',
  head: [['link', { rel: 'icon', href: `/favicon.ico`}],
  ],
}

完整目录结构如下：

- my-vuepress-test 文件夹
    - docs 文件夹
        - .vuepress 文件夹

       README.md
     package.json

还有其他文件 / 文件夹


7.  输入相关指令执行项目

npm run docs:dev (运行项目)


 

> tips: 如果运行此命令，在浏览器打开相应的地址还是返回 404 页面的话，可能你的相关依赖包没有全部安装成功，相关的路径出错，因该设置相应的 path 值。详情请查看官方：[https://vuepress.vuejs.org/zh/config/#%E5%9F%BA%E6%9C%AC%E9%85%8D%E7%BD%AE](https://vuepress.vuejs.org/zh/config/# 基本配置)

vuepress 搭建静态网站