总结的不全面,希望各位大神指定
vuePress 安装创建文件
步骤一:创建并进入一个新目录
mkdir vuepress-starter
cd vuepress-starter
步骤二:初始化项目
git init // 可以不写
// pnpm 方式
pnpm init
// yarn 方式
yarn init
// npm 方式
npm init
步骤三:安装本地依赖
// pnpm 方式
pnpm add -D vuepress@next @vuepress/client@next vue
// yarn 方式
yarn add -D vuepress@next
// npm 方式
npm install -D vuepress@next
步骤四:在 package.json 中添加一些 scripts
{
"scripts": {
"docs:dev": "vuepress dev docs",
"docs:build": "vuepress build docs"
}
}
步骤五:将默认的临时目录和缓存目录添加到 .gitignore 文件中
echo 'node_modules' >> .gitignore
echo '.temp' >> .gitignore
echo '.cache' >> .gitignore
步骤六:创建第一篇文档
mkdir docs
echo '# Hello VuePress' > docs/README.md
步骤七:启动文档网站
// pnpm 方式
pnpm docs:dev
// yarn 方式
yarn docs:dev
// npm 方式
npm run docs:dev
vuePress 的基本使用
1、vuePress 的基本概述
VuePress 是一款基于 Vue.js 的静态网站生成器,它使用了 Vue.js 和 Markdown 来创建高性能的静态网站。它专注于文档编写和技术文档的技术栈,旨在提供简单、高效和优雅的方式来创建文档网站。并且可以将其发布到 gitHub。
2、语法
2.1、标题
每行开头使用 1~6 个 # 号,对应的是 1~6 级标题
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
2.2、代码块
- 将每一行都缩进 4 个空格或者 1 个水平制表符
- 使用 ``` 内容 ``` JavaScript 指定语言配置
```
代码体/内容
```