# quick-net-docs

**Repository Path**: qve/quick-net-docs

## Basic Information

- **Project Name**: quick-net-docs
- **Description**: C# 快速开发库文档 支持 Net5, Net6架构，配合Vue3 qve项目实现低代码ORM等
- **Primary Language**: C#
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-02-23
- **Last Updated**: 2022-06-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: net, Vue

## README

# Net 文档

> 基于 vitepress 搭建文档模板

可快速搭建项目技术文档

- [在线代码测试文档](https://qve.gitee.io/docs/)
- [markdown 代码运行与搜索组件](https://www.npmjs.com/package/quick.run)

# 发布

- [新项目文档](http://docs.apwlan.com/net/)
- [新前端文档](http://docs.apwlan.com/ui/)
- [码云文档](https://qve.gitee.io/docs/)

- [旧项目文档](http://docs.apwlan.com/core)

## 重要提示

- 需修改源码二级目录路径问题，参考文档底部
- <strong>调试时可删除</strong>
- 编译缓存目录 `/node_modules/.vite`
- 更新搜索数据源`keywords.json`,删除将生成最新数据源

## 更新

- 0.1.1
  `2021-11-18`

  - quick-plugin-md:0.1.8

- 0.1.0
  `2021-11-06`

  - quick-plugin-md:0.1.5
  - vitepress:0.20.1

- 0.0.8
  `2021-05-24`

- 0.0.5
  `2021-02-24`

## 快速开始

- 安装

```bash
# 安装
yarn

# 调试vue
yarn docs:dev

# 打包项目
yarn docs:build

# 克隆项目
git clone git@gitee.com:qve/quick-net-docs.git
```

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

`/node_modules/.vite_opt_cache`

## 文档组件

- packages 文件夹

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

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

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

`</CodeRun>`

## 项目依赖

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

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

## 注意事项

目录名与文件名，请使用小写

### 二级目录路径问题

新`vitepress`已经解决，无需以下处理。

- vitepress 0.8.1 以下

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

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

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

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

  // 网站路径替换为文档目录
  pagePath = 'docs/' + pagePath.slice(base.length);
  pagePath = pagePath.replace(/\//g, '_') + '.md';
  // console.log(base,pagePath);
  ```