先全局安装
npm install -g vuepress
创建项目目录
mkdir vuepress-democd vuepress-demo
初始化项目
建立并编辑 package.json
npm init -y
进入package.json,修改脚本内容{建立基本目录
"scripts": {
"docs:dev": "vuepress dev docs",
"docs:build": "vuepress build docs"
}
}
vuepress-demo
├─package.json
├─docs
| ├─README.md
| ├─.vuepress
| | ├─config.js
| | ├─public
| | | └favicon.ico
修改配置文件 - config.js
module.exports = {
title: 'Hello VuePress',
description: 'Hello, my friend!',
head: [
['link', {
rel: 'icon',
href: `/favicon.ico`
}]
],
dest: './docs/.vuepress/dist',
ga: '',
evergreen: true,
}
修改README.md
VuePress 提供了对 YAML front matter 开箱即用的支持,我们可以模仿vuepress首页进行如下优化:---
home: true
heroImage: /favicon.ico
actionText: 快速上手 →
actionLink: /guide/
features:
- title: 简洁至上
details: 以 Markdown 为中心的项目结构,以最少的配置帮助你专注于写作。
- title: Vue驱动
details: 享受 Vue + webpack 的开发体验,在 Markdown 中使用 Vue 组件,同时可以使用 Vue 来开发自定义主题。
- title: 高性能
details: VuePress 为每个页面预渲染生成静态的 HTML,同时在页面被加载的时候,将作为 SPA 运行。
footer: MIT Licensed | Copyright © 2018-present xxxxxx
---
运行项目
vuepress dev docs
运行上述代码,最后会提示预览的网址http://localhost:8080/
README.md中的内容已完美呈现!
配置导航
首先在docs目录下建立文件
每个文件夹下的README.md就是当前目录的内容;
让我们通过config.js文件配置相应导航
themeConfig: {为guide文件下的README.md添加内容:
nav: [
{ text: 'Home', link: '/' },
{ text: 'Guide', link: '/guide/' },
{
text: 'Languages',
items: [
{ text: 'Chinese', link: '/language/chinese' },
{ text: 'English', link: '/language/english' }
]
},
{ text: 'External', link: 'https://www.baidu.com' },
]
}
## This is guide
content...
### title3
content...
### title3-01
## small title
content...
运行项目点击导航Guide,或是通过Home页点击“快速上手”会看到如下画面:

此时我们能够看到guide内容已成功显示,点击Lanuages能看到下拉,点击External会跳转到百度;
配置侧边栏
依旧在config.js文件下的themeConfig属性下添加:sidebarDepth: 2,
sidebar: [
{
title: 'Guide',
collapsable: false,
children: ['/guide/']
}
]
注:通过 themeConfig.sidebarDepth 来修改它的行为。默认的深度是 1,它将提取到 h2 的标题,设置成 0 将会禁用标题(headers)链接,同时,最大的深度为 2,它将同时提取 h2 和 h3 标题。
配置好后,运行项目
网友回复