VuePress 使用教程
目录
有两种方式:全局安装和项目中添加,我这里主要用于记笔记,所以选择全局安装。
npm i -g yarn
yarn global add vuepress # 或者:npm install -g vuepress ,推荐 yarn
mkdir notes_by_vuepress && cd notes_by_vuepress
echo '# Hello VuePress!' > README.md # 必须有 README.md
vuepress dev .
vuepress build .
默认情况下,文件将会被生成在 .vuepress/dist
,可通过 .vuepress/config.js
中的 dest
字段修改。
在文档目录下创建.vuepress
目录,所有与 VuePress 相关文件存放在此处。
例如新建一个 config.js
module.exports = {
title: '语含鎏-学习笔记',
description: '原创文章,版权所有,鼓励实践,抵制盗文',
base: '/notes/' // 应该总是以斜杠开始,并以斜杠结束
}
如果希望网站部署到非根路径,则需要配置基础路径的base
值。
favicon.ico 文件应放在 public
文件夹下,当设置了base
值之后,在文件中引用资源最好使用一个助手函数$withBase('/foo.png')
,markdown 中也能用。
用你熟悉的 markdown 语法,同时提供了语法扩展。
markdown 中也能使用 vue ,由于是服务端渲染,因此必须编写通用代码。
有关默认主题的配置,包括导航栏、侧边栏的内容,在官方文档有详细解释。