# docs-accompany-reading

**Repository Path**: eyehwan/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**: 1
- **Forks**: 6
- **Created**: 2022-09-27
- **Last Updated**: 2022-09-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request