# docs-accompany-reading

**Repository Path**: openeuler/docs-accompany-reading

## Basic Information

- **Project Name**: docs-accompany-reading
- **Description**: The repository of docs-accompany-reading template
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 6
- **Created**: 2022-09-20
- **Last Updated**: 2024-11-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: sig-OpenDesign

## README

# docs-accompany-reading(文档伴读)

#### 介绍

本仓库提供了 openeuler 的文档捉虫代码，可用于对开源文档的用户体验提升。
功能包含：
1. 划取社区文档片段，跳出“有虫”描述对话框。
2. 创建Gitee Issue，PR链接的自动跳转。

注意:目前本仓库代码仅支持功能展示及具体实现的代码参考,不具备直接引入使用功能
#### 目录结构
```
website
├─ css // 页面的 css 文件
├─ img // 页面的图片文件
├─ js // 页面的 js 文件
├─ index.html // 页面
```

#### 使用说明

1.  clone 仓库代码
2.  找到 website 路径下的 index.html
3.  双击找到的 index.html 即可在浏览器中打开，查看展示效果

#### 捉虫具体流程说明

1. 用户找到需要捉虫的网页,根据提示打开捉虫弹窗(弹窗内需用户填入内容需要根据网页需求进行自定义设计)
2. 用户正确输入捉虫内容
3. 在用户点击跳转前可依据网站的需求自行决定是否使用后端接口接收用户的捉虫数据（这里要做gitee账号的登录提示，否则gitee网站无法正确跳转）
4. 在跳转git代码仓时按规则（具体规则可参考docdetail.js内的代码跳转地址参数）携带参数后，git那边通过识别会跳转到相应网页让用户进行提交issue或pr的操作(这里必须保证用户已经登录了gitee账号否则无法正常跳转，所以在第三步时做好提示)