vuepress 目录结构

VuePress 遵循 “约定优于配置” 的原则,推荐的目录结构如下:

.
├── docs
│   ├── .vuepress (可选的)
│   │   ├── components (可选的)
│   │   ├── theme (可选的)
│   │   │   └── Layout.vue
│   │   ├── public (可选的)
│   │   ├── styles (可选的)
│   │   │   ├── index.styl
│   │   │   └── palette.styl
│   │   ├── config(可选的)
│   │   ├── config.js
│   │ 
│   ├── guide
│   │   └── README.md
│   ├── life(自定义举例用)
│   │   └── life01.md
│   │   └── life02.md
│   │   └── life03.md
│   │   └── README.md
│   ├── study(自定义举例用)
│   │   └── english
│   │   │   └── english01.md
│   │   │   └── english02.md
│   │   │   └── english3.md
│   │   └── math
│   │   │   └── math01.md
│   │   │   └── math02.md
│   │   │   └── math3.md
│   ├── README.md
│ 
└── package.json

::: warning
我们后面的所有示例都是基于这个目录结构讲解的。
:::

  • 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/config: 当config.js里面内容太多时,可以把每一项配置都分割成单独的文件存放到config文件夹。
  • docs/.vuepress/config.js: 全局配置文件。
  • docs/guide: 一般用户都在这个目录下创建网站指南,当然你可以不用。
  • docs/guide/README.md: 指南里面的具体内容,内容使用markdown书写。
  • docs/guide/life: 自定义举例用,我们后面的例子都是在这里完成的。
  • docs/guide/study: 自定义举例用,我们后面的例子都是在这里完成的。

本地工程示例图

本地工程示例图

🍉🍉🍉 欢迎大家来博客了解更多内容:java乐园 🍉🍉🍉

vuepress入门详解(一)vuepress介绍
vuepress入门详解(二)vuepress 快速搭建
vuepress入门详解(三) vuepress 目录结构
vuepress入门详解(四)vuepress 基本配置
vuepress入门详解(五)vuepress Markdown详解
vuepress入门详解(六)vuepress 实用插件
vuepress入门详解(七)vuepress如何添加评论功能

Logo

前往低代码交流专区

更多推荐