# docs

**Repository Path**: eucalyptus_and_eucalyptus/docs

## Basic Information

- **Project Name**: docs
- **Description**: 极简快速的文档模板，支持vue 3.x组件，扩展全站搜索与在线js代码调试， 基于 vitepress 构建。
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 5
- **Created**: 2021-01-24
- **Last Updated**: 2022-05-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Quick.Docs

> 基于 vitepress 搭建文档模板

可快速搭建 vue 3.x 项目技术文档

- [点击打开在线代码测试文档](https://qve.gitee.io/docs/)

## 更新

- 0.0.2
  `2020-10-09`

  - 样式更新
  - `CodeRun` 新增 styled 代码样式定义

- 0.0.1
  `2020-10-06`

  - 样式适配
  - 全站搜索框，支持二级标题
  - 代码在线调试，绿色标识框

## 快速开始

- 安装

```bash
# npm 安装
npm i

# 调试vue
npm run dev

# 打包项目
npm run build
```

- vite 清除缓存目录，解决部分热更新问题

`/node_modules/.vite_opt_cache`

## 文档组件

- packages 文件夹

### `CodeRun` 代码在线调试

| 属性     | 说明                       | 类型    | 默认值 |
| -------- | -------------------------- | ------- | ------ |
| dll      | 需要调试的 api 名称        | String  |        |
| editable | 代码可编辑                 | Boolean | false  |
| unmini   | 不执行压缩 unmini,默认解码 | Boolean | false  |
| ubb      | 不执行解码 ubb,默认解码    | Boolean | false  |
| styled   | code 样式定义              | String  |        |

`<CodeRun dll="json" styled="height:20rem" ubb editable>`

```js
// js 在线测试执行代码
return 'test';
```

`</CodeRun>`

## 项目依赖

- [quick.lib](https://www.npmjs.com/package/quick.lib)

- [vitePress](https://github.com/vuejs/vitepress)

## 注意事项

### 二级目录路径问题

本项目配置了二级目录，发布后需要调整文件夹路径。

- vitepress 0.6.0

  需要发布为二级目录时，调试正常正式发布时会导致路径错误，
  需要修改以下文件。

  `node_modeules\vitepress\dist\client\app\utils.js`

  第 20 行（把整个 base 路径删除了导致 Bug 修改为 1 正常取值）

  ```js
  //pagePath = pagePath.slice(base.length).replace(/\//g, '_') + '.md';
  pagePath = pagePath.slice(1).replace(/\//g, '_') + '.md';
  ```