https://github.com/rust-lang-cn/rustdoc-cn

rustdoc 手册 中文版————Chinese translation of The rustdoc Book
https://github.com/rust-lang-cn/rustdoc-cn

book rust rust-lang rust-lang-cn rustdoc

Last synced: 24 days ago
JSON representation

rustdoc 手册 中文版————Chinese translation of The rustdoc Book

• Host: GitHub
• URL: https://github.com/rust-lang-cn/rustdoc-cn
• Owner: rust-lang-cn
• License: apache-2.0
• Created: 2021-05-19T11:28:52.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-06-15T15:35:06.000Z (11 months ago)
• Last Synced: 2025-04-05T12:51:09.275Z (about 2 months ago)
• Topics: book, rust, rust-lang, rust-lang-cn, rustdoc
• Language: JavaScript
• Homepage: https://rustwiki.org/zh-CN/rustdoc/
• Size: 109 KB
• Stars: 13
• Watchers: 5
• Forks: 9
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# rustdoc 手册

![Build Status](https://github.com/rust-lang-cn/rustdoc-cn/workflows/CI/badge.svg)

[![LICENSE-MIT](https://img.shields.io/badge/license-MIT-green)](https://raw.githubusercontent.com/rust-lang-cn/rustdoc-cn/master/LICENSE-MIT)

[![LICENSE-APACHE](https://img.shields.io/badge/license-Apache%202-blue)](https://raw.githubusercontent.com/rust-lang-cn/rustdoc-cn/master/LICENSE-APACHE)

[![GitHub last commit](https://img.shields.io/github/last-commit/rust-lang-cn/rustdoc-cn?color=gold)](https://github.com/rust-lang-cn/rustdoc-cn/commits/master)

[![GitHub contributors](https://img.shields.io/github/contributors/rust-lang-cn/rustdoc-cn?color=pink)](https://github.com/rust-lang-cn/rustdoc-cn/graphs/contributors)

![Locatized 100%](https://img.shields.io/badge/localized-100%25-purple)

[![rustwiki.org](https://img.shields.io/website?up_message=rustwiki.org&url=https%3A%2F%2Frustwiki.org)](https://rustwiki.org)

> The Chinese Translation of [The rustdoc Book][rustdoc-book-en]

>

> - 首次于 2022-02-04 翻译完全部内容，欢迎纠正——最后更新时间 2022-02-04。

> - [David][david] 翻译完成本文档，并加入了 Rust 翻译小组群，期待更多朋友加入 [Rust 中文翻译项目组](https://github.com/rust-lang-cn)，协助我们，一起更新完善中文版，感激不尽！

这是《rustdoc 手册》中文版，翻译自 [Rust 源码中的《rustdoc Book》][rustdoc-book-src]。

在线版可在本组织官网上[阅读中文版][rustdoc-book-cn]（**支持同一页面中英双语切换**）或在 Rust 官网上[阅读英文版][rustdoc-book-en]。

[david]: https://github.com/wendajiang

[rustdoc-book-src]: https://github.com/rust-lang/rust/tree/master/src/doc/rustdoc

[rustdoc-book-cn]: https://rustwiki.org/zh-CN/rustdoc/

[rustdoc-book-en]: https://doc.rust-lang.org/rustdoc/

## 构建

构建之前请先安装 `mdBook` 工具。

从 GitHub 下载仓库并构建：

```sh

$ git clone https://github.com/rust-lang-cn/rustdoc-cn.git

$ cd rustdoc-cn

$ mdbook serve

```

然后就可以在浏览器上访问 `http://localhost:3000` 来查看文档内容了。

要生成本地图书，使用以下命令：

```sh

$ mdbook build

```

即可在当前仓库目录下生存一个 `book` 子目录，可找到相应的 HTML 文件。

## 许可协议

《rustdoc 手册》（中文版与英文版 *rustdoc Book* 均） 使用以下两种协议的任一种进行授权：

- Apache 2.0 授权协议，（[LICENSE-APACHE](LICENSE-APACHE) 或 http://www.apache.org/licenses/LICENSE-2.0）

- MIT 授权协议 ([LICENSE-MIT](LICENSE-MIT) 或 http://opensource.org/licenses/MIT)

可以根据自己选择来定。

除非您有另外说明，否则您在本仓库提交的任何贡献均按上述方式进行双重许可授权，就如 Apache 2.0 协议所规定那样，而无需附加任何其他条款或条件。