介绍
oldbirds 8/17/2020 toolsvuepress
# VuePress 是什么?
- Vue 驱动的静态网站生成器
- 简洁至上 以 Markdown 为中心的项目结构,以最少的配置帮助你专注于写作。
- Vue驱动 享受 Vue + webpack 的开发体验,可以在 Markdown 中使用 Vue 组件,又可以使用 Vue 来开发自定义主题。
- 高性能 VuePress 会为每个页面预渲染生成静态的 HTML,同时,每个页面被加载的时候,将作为 SPA 运行。
详情请看官网 VuePress (opens new window)
# 安装
# 全局安装
npm install -g vuepress
# 创建项目
mkdir blog & cd blog
npm init -y
创建完成后会有一个 package.json
{
"name": "blog",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC"
}
根据官方文档,将 scripts
改成:
"scripts": {
"docs:dev": "vuepress dev docs",
"docs:build": "vuepress build docs"
}
# 添加 docs 文件夹
mkdir docs
这个文件夹中主要放些你的配置和所写的博客内容
# 在 docs 文件夹中创建 .vuepress 文件夹
cd docs
mkdir .vuepress
这个文件夹中你就可以放配置 (opens new window)了。
# 目录结构
blog //项目文件夹
├─── docs
│ ├──── README.md //一般用来做首页
│ └──── .vuepress //用于存放全局的配置、组件、静态资源等
| ├── components //该目录中的 Vue 组件将会被自动注册为全局组件
│ ├── public // 静态资源目录
| ├── override.styl //用于重写默认颜色常量,或者设置新的 stylus 颜色常量。(定义的样式常量可以在vue组件中直接使用)
| ├── style.styl //会被自动应用的全局样式文件,具有比默认样式更高的优先级(需要覆盖的默认样式代码写在该文件里)
│ └── config.js //配置文件的入口文件(即配置性的东西基本在这配置)
└── package.json
官方文档比较详细,建议直接采用文档的步骤。
# 配置参考
有些细节的东西,可能在官方文档上没有提现出来,我们可以借鉴别人的的一些配置。这里推荐几个: