25 lines
1.6 KiB
Markdown
25 lines
1.6 KiB
Markdown
# LinkTool文档库
|
||
|
||
## 简介
|
||
|
||
本仓库为基于Vitepress的LinkTool文档库，内容涵盖LinkTool的开发过程、使用方法等。
|
||
|
||
## 协作指南
|
||
|
||
### 项目结构
|
||
|
||
所有文件名和文件夹均使用英文命名，单词之间使用`-`连接，不留空格。项目根目录下分设web、plugin、agent文件夹，分别对应Web端、插件端和智能体的部分，每个部分内区分“开发指南”何“使用方法”两个部分，即dev和usage文件夹，两部分的文档分别面向开发者和用户。
|
||
|
||
### 参与协作
|
||
|
||
可直接使用Visual Studio Code（推荐）或Intellij Idea、PyCharm等集成开发环境打开本项目，创建自己的分支后，直接开始编辑相应的文档。
|
||
|
||
如果需要添加新的文章，在`/.vitepress/config.mts`中的sidebar添加相应的item，原则上不允许添加新的侧边栏组，nav中也不允许添加其它的子项目，文档中涉及的图片全部放到assets文件夹中，严禁在Markdown文档所在文件夹放图片。
|
||
|
||
### 语法参考
|
||
|
||
由于本项目基于Vitepress搭建，所以也支持Vitepress中对于Markdown语法的扩展，可以排版出美观的项目文档，具体参考[Vitepress官方文档](https://vitepress.dev/zh/reference/default-theme-config)
|
||
|
||
## 文档预览
|
||
|
||
对于普通Markdown语法部分（占据文档库的大部分内容）可以直接使用Visual Studio Code自带的Markdown预览器预览效果，对于Vitepress拓展部分，可以通过`npm run docs:dev`命令开启实时预览，开启后，每次文档内容有更新就会自动刷新；也可以通过`npm run docs:build`生成相应的html文件。 |