The Chinese Translation of The rustdoc Book
- 首次于 2022-02-04 翻译完全部内容,欢迎纠正——最后更新时间 2022-02-04。
- David 翻译完成本文档,并加入了 Rust 翻译小组群,期待更多朋友加入 Rust 中文翻译项目组,协助我们,一起更新完善中文版,感激不尽!
这是《rustdoc 手册》中文版,翻译自 Rust 源码中的《rustdoc Book》。
在线版可在本组织官网上阅读中文版(支持同一页面中英双语切换)或在 Rust 官网上阅读英文版。
构建之前请先安装 mdBook
工具。
从 GitHub 下载仓库并构建:
$ git clone https://github.com/rust-lang-cn/rustdoc-cn.git
$ cd rustdoc-cn
$ mdbook serve
然后就可以在浏览器上访问 https://localhost:3000
来查看文档内容了。
要生成本地图书,使用以下命令:
$ mdbook build
即可在当前仓库目录下生存一个 book
子目录,可找到相应的 HTML 文件。
《rustdoc 手册》(中文版与英文版 rustdoc Book 均) 使用以下两种协议的任一种进行授权:
- Apache 2.0 授权协议,(LICENSE-APACHE 或 https://www.apache.org/licenses/LICENSE-2.0)
- MIT 授权协议 (LICENSE-MIT 或 https://opensource.org/licenses/MIT)
可以根据自己选择来定。
除非您有另外说明,否则您在本仓库提交的任何贡献均按上述方式进行双重许可授权,就如 Apache 2.0 协议所规定那样,而无需附加任何其他条款或条件。