# vuepress2

**Repository Path**: mosowe/vuepress2

## Basic Information

- **Project Name**: vuepress2
- **Description**: 【vuepress基础模板】基于vuepress1.x+element2.x+vue2.x创建，vuepress2中的2是指vue2.x
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-11-10
- **Last Updated**: 2022-12-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 禁删

## README

---
title: '介绍'
order: 0
---

[基于vuepress1.X版本](https://vuepress.vuejs.org/zh/)

> vuepress@1.X
>
> vue@2.X
>
> element@2.X

# /docs 目录下

## 规范

1. `/docs/readme.md`或`/docs/index.md`会被视为网站首页，其路由为`/`;
2. 文件夹及md文件均以`小驼峰命名`；
3. 约定以`Group`结尾的文件夹将会作为一个组；
4. `Group文件夹`可以创建`config.json`文件用于配置组信息，若没有则以注释内容配置组信息，格式如下：

  ```json
  {
    "title": "测试分组", // 没有则以文件夹名称为title
    "order": 2, // 组排序，number类型，没有则为0
    "collapsable": false // 组默认展开或收起，不写默认false
    // 其他组配置项
  }
  ```

5. 每个`Group文件夹`文件夹下面的`index.md`或者`readme.md`文件将会被视为该分组下首页，其路由为`/xxxGroup/`；
6. 每个`.md`文件第一行应为如下[格式](https://vuepress.vuejs.org/zh/guide/frontmatter.html#%E5%85%B6%E4%BB%96%E6%A0%BC%E5%BC%8F%E7%9A%84-front-matter)，均为可选：

  ```json
  ---
  title: '介绍' // 没有则以文件名称为title
  order: 0 // number类型，没有则为0
  ---
  ```

**注意key-value间的空格**，生成侧边栏数据时会读取`.md`文件夹下第一行的该声明内容，若未声明，则会以文件名为左侧标题名称且排序为0，文档搜索也是依据该格式下的title；

## 注意事项

1. 每次增删`.md`文件或组都需要重新生成一下侧边栏数据；
2. 同级目录下存在`index.md`和`readme.md`，左侧栏都会显示这两个路由名，但内容为后生成路由的那个文件；
3. 非`Group`结尾的文件夹下的文件，将会以一级菜单形式粗在于左侧栏；
4. `/.vuepress/components`文件夹存放的是vue2.x组件，且自动全局注册，可以在`md`文件中直接使用；
5. 侧边栏默认是全展开的形式；
6. 文中有二级标题的，点击该导航后将会在侧边栏生成二级导航，这种就是一篇到底的形式，采用锚点定位方式，如本页。
7. 打包后的`/dist`文件夹在`.vuepress`文件夹下

## 内置组件

### codeShow

类似于element组件库演示那种类型

**注意：直接预览md文件不会渲染组件**

::: demo <test />
<<< @/docs/.vuepress/components/test.vue
:::

## 运行

先生成侧边栏目录：

`npm run nav`

会生成/utils/sidebar.js文件，里面是侧边栏的数组

本地运行：

`npm run dev`

打包：

`npm run build`


## 相关链接

[vuepress](https://vuepress.vuejs.org/zh/)

[码云地址](https://gitee.com/mosowe/vuepress2)