# node-api-cn

**Repository Path**: tyss521/node-api-cn

## Basic Information

- **Project Name**: node-api-cn
- **Description**: Node.js API 中文文档
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-03-17
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Node.js API 中文文档

## 1、如何参与翻译？

- 进入 API 模块，如 assert（[http://nodejs.cn/api/assert.html](http://nodejs.cn/api/assert.html)）。
- 每个小标题下有【查看英文md文件】与【编辑中文md文件】2个入口。
- 进入【编辑中文md文件】可对页面进行修改并创建 pull request，[模块管理员]审核通过后会自动构建到预览版页面，如   assert（[http://nodejs.cn/api/dev/assert.html](http://nodejs.cn/api/dev/assert.html)，URL 比正式版多了/dev/），构建过程大概耗时20秒钟。
- 进入【查看英文md文件】可查看原始的英文 markdown 文件，方便内容对比。
- 每天会不定时从预览版同步到正式版。

### 特殊配置文件

- __header.js: 文档的标题，通过锚点映射。
- __link.md: 文档中的markdown链接。


## 2、模块管理员

为了保证API文档的翻译质量，需要精通或熟悉某一模块的模块管理员进行长期持续的维护。

- 模块管理员会获得github仓库的push权限。
- 每人暂时只能申请一个模块。

## 如何申请模块管理员
- 从你想要申请的模块中挑选一个或多个能体现你专业水平的段落进行翻译，提交时注明【申请成为模块管理员】。
- 如果章节已翻译，请无视它，用你更专业的水平对它进行重构。
- 为了方便联系，请先加QQ群：713382。

## 现任模块管理员
- cluster模块: [AmandaYi]
- crypto模块: [yilikun]
- fs模块: [QC-L]
- module模块：[adrianzqt]
- net模块: [nodejh]
- path模块: [fengshadu]
- stream模块：[Yi-love]

## 撤销模块管理员
- 如果管理员因各种原因无法继续维护文档，可以申请退出，后续可重新申请加入。
- 如果模块管理员连续一个月未对模块提交更新，则视为退出。

## 历任模块管理员
暂无


[API文档正式版]: http://nodejs.cn/api/
[API文档开发版]: http://nodejs.cn/api/dev/
[模块管理员]: https://github.com/nodejscn/node-api-cn/blob/master/README.md#模块管理员

[AmandaYi]: https://github.com/AmandaYi
[yilikun]: https://github.com/yilikun
[QC-L]: https://github.com/QC-L
[adrianzqt]: https://github.com/adrianzqt
[nodejh]: https://github.com/nodejh
[fengshadu]: https://github.com/fengshadu
[Yi-love]: https://github.com/Yi-love