vuepress搭建静态网站

vuepress搭建静态网站

1. 全局安装

   npm install -g vuepress 或者 yarn global add vuepress

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

   mkdir my-vuepress-test  (新建文件夹)
   
   cd my my-vuepress-test  (切换至my-vuepress-test文件夹下)
   
   npm init -y  (-y表示使用默认方式创建package.json)
   

3. 打开自动生成的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文件夹里面的内容）

4. 然后在my-vuepress-test夹中创建docs文件夹，然后在创建README.md文件(编译启动后默认展示文件)

   //README.md 文件里面 随便输入一些内容 相当于index.html 例如：
   # Hello VuePress 初次遇见

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

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

6. 完整目录结构如下：

   - 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/#基本配置)