leizongmin/node-doc-cn

Node.js中文文档

Node.js API 中文版在线翻译系统

安装

系统环境要求：

• MySQL 5.x
• Node.js >= 0.8

git clone https://github.com/leizongmin/node-doc-cn.git
cd node-doc-cn
cp config.default.js config.js

• 将 tables.sql 导入数据库中
• 修改配置文件 config.js

npm install
node app

工作原理

Node.js 的 API 文档是使用 Markdown 格式来编写的，这种文档有一个共同特征：每个 段落都是通过一个空行来分割的。

在翻译之前，先通过程序 tool/import_origin.js 来读取 origin/api 目录下的所有 .markdown 文件，并分割为多个段落，存储到数据库中。

每个段落都会根据其内容，用 md5() 来生成一个 hash 属性，翻译的时候，每条翻译 结果也对应与该段落的 hash。

当 Node.js API有更新时，重新分割文档的 markdown 文件即可，大多数的段落内容没有 更改，那么仍然能使用旧的翻译结果。

授权

MIT

node-doc-cn's Issues

手机上看不能往下滑动

手机上进http://nodeapi.ucdok.com/#/api/，不可以往下滑动。

官方英文的文档网页是可以的呢

能提供下表结构的脚本吗？

如题。

待翻译完成后，需要人工整理

• 处理段落类型识别不准确问题：
  • 有些代码块是 ``` 开头的，而导入的时候是根据4个空格来判断的
  • 在代码段中有空行时，被拆分了，需要合并
• 翻译结果页面，中英文对照

请调整一下网页字体

宋体无论在哪个系统都发虚，即使 Retina 屏幕也一样！

网速较慢时，用户首次翻译某一段落，连续点击两次可能会导致在数据库中保存了两条结果

解决方法：在前端限制，提交未完成时，不能重复点“保存”

为何每个api都没有功能解释

有些api都不知道啥意思的

synopsis.html 代码不全

synopsis.html 代码不全

dns.getServers() 和 dns.setServers(servers)

http://nodejs.org/api/dns.html
官方已删除

to_html.js 73行 xss过滤后,链接href丢失

    // XSS过滤
    content = xss(content);

是我xss或其他什么组件版本的问题吗?
还是大家都有遇到?

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

response.writeHead()翻译错误

response.writeHead()必须在response.end() 之前调用

在文档页面中显示“纠错”和“翻译”按钮

对于还没有翻译的段落，应该在旁边显示“翻译”按钮，方便直接提交翻译。
对于已经翻译的锻炼，在旁边显示“纠错”按钮，以便于发现错误后提交更正，同时可以选择不同的翻译结果

翻译好的文档在哪里？

如题。

无关翻译的，是log，月份显示的是8月..

http://nodeapi.ucdok.com/user/id/4 任意点击某人，他的翻译时间的月份都是8月。。应该是9月的。。

代码块缺失问题

smalloc章节的代码块有缺失，需要检查一下合并相邻代码块的程序是否有问题

需要“完成进度”功能

方便找出哪些章节还没有翻译

再次导入API原文档时，可能会丢失部分已翻译的数据

翻译结果是按照段落内容的md5值来区分的，当使用不同的的设定从git中导入代码、或者使用了不同的编辑器编辑后，可能会导致换行符改变了（比如原来是 \n ，修改后变成了 \r\n ），这样虽然看起来内容是一样的，但是md5值却不同了。

待翻译完后，需要修正一下数据库内容：

• 把换行符统一转换为 \n
• 对相邻的代块进行合并

示例代码丢失严重，如:http模块的http.request(options, [callback])的示例代码

URL：http://nodeapi.ucdok.com/api/http.html#http_http_request_options_callback_3163
中文版的只有：
// write data to request body
req.write('data\n');
req.write('data\n');
req.end();

英文版的为：
var options = {
hostname: 'www.google.com',
port: 80,
path: '/upload',
method: 'POST'
};

var req = http.request(options, function(res) {
console.log('STATUS: ' + res.statusCode);
console.log('HEADERS: ' + JSON.stringify(res.headers));
res.setEncoding('utf8');
res.on('data', function (chunk) {
console.log('BODY: ' + chunk);
});
});

req.on('error', function(e) {
console.log('problem with request: ' + e.message);
});

// write data to request body
req.write('data\n');
req.write('data\n');
req.end();

类似的情况在中文版API里还不少

翻译时，代码块应该使用代码编辑器来编辑

建议

建议弄成 英中文对照阅读 的格式。

代码块中的空行被当成章节切割

在 stream 章节尤为明显，不知有没有办法解决？