鸭梨公共文档

主题

1. 文档编写规范 ​

1. 文档编写要求 ​

文档编写的第一要素是清晰易懂，方便他人阅读和理解，同时也要保证文档的准确性和完整性。

  1. 将一般文档放在各自项目的文件夹 docs/ 下面。
  2. 使用 MarkDown 来编写，并遵循 MarkDown 规范 来编写。
  3. 对于一些架构设计、技术关键点和易错点需要在文档中着重标注。

2. 编写 E-R 图 ​

架构层面设计的实体模型需要使用 E-R 图表示，使用 Mermaid E-R 图 语法来编写，方便后续的维护，示例如下：

E-R 图
md
```mermaid
erDiagram
    Picture ||--o{ Comment : "图片的评论"
    Tag ||--o{ PictureTag : "关联标签"
    Picture ||--o{ PictureTag : "关联标签"
    Catalog ||--o{ Picture : "关联目录"
    Catalog ||--o{ Catalog : "父类目"
```

3. VitePress ​

目前我们使用 VitePress 来编写文档，使用方法以本项目自身所使用的依赖为准。使用标准主题，并集成了各种在编写文档中需要的功能，如常见 MarkDown 插件、Mermaid、KaTeX 等。

下面是一些使用技巧：

  1. 使用 [[TOC]] 在文章内部生成目录。
  2. 使用 @mdit/plugin-stylize 支持的自定义样式，如 *@TODO* 用于定义待办事项。

具体地，如果现有的内容不能满足你的要求，可以自定义 Vue 组件来实现，我们可以在 MarkDown 中直接使用 Vue 组件。