VuePress简介:
- 话不多说直接上官方文档 VuePress 中文文档 | VuePress 中文网
- 以 Markdown 为中心的项目结构,以最少的配置帮助你专注于写作。
- 享受 Vue + webpack 的开发体验,可以在 Markdown 中使用 Vue 组件,又可以使用 Vue 来开发自定义主题。
- VuePress 会为每个页面预渲染生成静态的 HTML,同时,每个页面被加载的时候,将作为 SPA 运行。
注意:
请确保你的 Node.js 版本 >= 8.6。
目录基本结构:
.
├── docs
│ ├── .vuepress (可选的)
│ │ ├── components (可选的)
│ │ ├── theme (可选的)
│ │ │ └── Layout.vue
│ │ ├── public (可选的)
│ │ ├── styles (可选的)
│ │ │ ├── index.styl
│ │ │ └── palette.styl
│ │ ├── templates (可选的, 谨慎配置)
│ │ │ ├── dev.html
│ │ │ └── ssr.html
│ │ ├── config.js (可选的)
│ │ └── enhanceApp.js (可选的)
│ │
│ ├── README.md
│ ├── guide
│ │ └── README.md
│ └── config.md
│
└── package.json
注意:
请留意目录名的大写。
-
docs/.vuepress
: 用于存放全局的配置、组件、静态资源等。 -
docs/.vuepress/components
: 该目录中的 Vue 组件将会被自动注册为全局组件。 -
docs/.vuepress/theme
: 用于存放本地主题。 -
docs/.vuepress/styles
: 用于存放样式相关的文件。 -
docs/.vuepress/styles/index.styl
: 将会被自动应用的全局样式文件,会生成在最终的 CSS 文件结尾,具有比默认样式更高的优先级。 -
docs/.vuepress/styles/palette.styl
: 用于重写默认颜色常量,或者设置新的 stylus 颜色常量。 -
docs/.vuepress/public
: 静态资源目录。 -
docs/.vuepress/templates
: 存储 HTML 模板文件。 -
docs/.vuepress/templates/dev.html
: 用于开发环境的 HTML 模板文件。 -
docs/.vuepress/templates/ssr.html
: 构建时基于 Vue SSR 的 HTML 模板文件。 -
docs/.vuepress/config.js
: 配置文件的入口文件,也可以是YML
或toml
。 -
docs/.vuepress/enhanceApp.js
: 客户端应用的增强。
注意:
当你想要去自定义
templates/ssr.html
或templates/dev.html
时,最好基于 默认的模板文件 (opens new window)来修改,否则可能会导致构建出错。
默认的页面路由:
此处我们把 docs
目录作为 targetDir
(参考 命令行接口),下面所有的“文件的相对路径”都是相对于 docs
目录的。在项目根目录下的 package.json
中添加 scripts
:
{
"scripts": {
"dev": "vuepress dev docs",
"build": "vuepress build docs"
}
}
文件的相对路径 | 页面路由地址 |
---|---|
/README.md |
/ |
/guide/README.md |
/guide/ |
/config.md |
/config.html |
就先说到目录结构这里,想了解更多记得查看官方文档!!!
个人搭建的一个VuePress框架 GitHub 地址: