# openCV.js-doc-zh

**Repository Path**: moqi-y/openCV.js-doc-zh

## Basic Information

- **Project Name**: openCV.js-doc-zh
- **Description**: OpenCV.js中文文档
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: https://cvdoc.netlify.app
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 1
- **Created**: 2023-08-25
- **Last Updated**: 2025-06-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### 简介

这是一个由我进行的非专业性的OpenCV.js文档翻译，也是一个精简版OpenCV.js中文文档。

旨在帮助和我一样初次接触OpenCV.js的前端小伙伴快速上手，免去因阅读英文文档带来的阅读障碍；

**如何使用：**

1、打开OpenCV.js中文文档网站：[OpenCV.js (中文文档)](https://opencv.201005.xyz "点击打开网站")

2、在该项目仓库中查看示例代码，示例代码文件夹 **`demo`** ,示例代码路径：`openCV-doc-zh/demo/xxx.html`

**如何参与精简版OpenCV.js文档翻译？**

**第一步：克隆该项目**

```
git clone git@github.com:moqi-y/openCV.js-doc-zh.git
```

**第二步：下载本地运行服务器live-server，用于查看编辑效果**

```
npm install -g live-server
```

**第三步：在本地资源管理器打开项目目录，找到 `index.html`文件所在目录，文件路径 `openCV-doc-zh/docs/index.html`**

**第四步：在当前目录（`openCV-doc-zh/docs/`）运行cmd窗口，在cmd窗口输入 `live-server`命令，运行本地服务器，例如：**

E:\mycode\openCV-doc-zh\docs>live-server

**第五步：成功运行！**

现在你就可以看到运行起来的文档了！你也可以到 `openCV-doc-zh/docs/`（与当前 `index.html`文件同一目录）下的README.md文件中参与文档编写，保存后浏览器中的文档会自动热更新。

**备注：**

参考文档：[OpenCV: OpenCV modules](https://docs.opencv.org/3.3.1/index.html "点击打开网站")

热烈欢迎有兴趣的小伙伴加入该文档的翻译工作，一起帮助其他伙伴上手OpenCV.js！