本份 Web3.js 中文文档由登链社区发起,由Cell Network 和 登链社区 共同赞助。 如果你对我们的翻译计划感兴趣,来看看招募译者 .
登链社区区块链技术文档中心 已经有很多文档,本Web3.js 中文文档托管在 https://learnblockchain.cn/docs/web3.js/ 。
未经授权,请勿转载。
本文档翻译遵循以下原则:
- 尊重原文档的结构、格式
- 采用认领、翻译、校对、发布流程。
注意事项
- 为避免译者重复翻译,译者需要提前认领一周的工作量,认领和翻译完成时,都需要及时更新进度文件
- 翻译时,除了用语规范外,还要注意文件间链接跳转正确
- 翻译完成后,译者之间需要相互校对,可以在GitHub提交PR后,译者群里告知一下译者同伴。
Fabric官方文档主要是使用reStructuredText格式,部分使用Markdown格式,使用 Sphinx 编译为 HTML。
因此我们需要安装下Sphinx。
- 安装Sphinx
pip install Sphinx -U
pip install sphinx_rtd_theme
如果安装的时候太慢,可以使用清华的源,pip 加入参数: -i https://pypi.tuna.tsinghua.edu.cn/simple
- 翻译及编译文档
// 切出自己的分支
git checkout -b mybranch
// 编译文档
make html
文档会输出在 _build/html
, 可以直接在浏览器打开index.html.
- 提交Pull Request
翻译完成后,先自己检查一篇,没问题后,提交Pull Request,告诉队友Review.