Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rust-lang/reference
The Rust Reference
https://github.com/rust-lang/reference
documentation reference rust rust-lang
Last synced: about 1 month ago
JSON representation
The Rust Reference
- Host: GitHub
- URL: https://github.com/rust-lang/reference
- Owner: rust-lang
- License: apache-2.0
- Created: 2017-03-01T16:21:06.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-13T19:05:31.000Z (3 months ago)
- Last Synced: 2024-08-13T20:17:07.474Z (3 months ago)
- Topics: documentation, reference, rust, rust-lang
- Language: Rust
- Homepage: https://doc.rust-lang.org/nightly/reference/
- Size: 4.14 MB
- Stars: 1,196
- Watchers: 41
- Forks: 466
- Open Issues: 305
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# The Rust Language Reference
This document is the primary reference for the Rust programming
language.
This document is not normative. It may include details that are specific
to `rustc` itself, and should not be taken as a specification for the
Rust language. We intend to produce such a document someday, but this is
what we have for now.
## Dependencies
- Nightly Rust
- [mdbook](https://rust-lang.github.io/mdBook/)
## Installing dependencies
First, ensure that you have a recent copy of the nightly Rust compiler
installed, as this is needed in order to run the tests:
```sh
rustup toolchain install nightly
```
Now, ensure you have `mdbook` installed, as this is needed in order to
build the Reference:
```sh
cargo install --locked mdbook
```
## Building
To build the Reference, first clone the project:
```sh
git clone https://github.com/rust-lang/reference.git
```
(Alternatively, if you don't want to use `git`, [download][] a ZIP file
of the project, extract it using your preferred tool, and rename the
top-level directory to `reference`.)
[download]: https://github.com/rust-lang/reference/archive/refs/heads/master.zip
Now change your current directory to the working directory:
```sh
cd reference
```
To test all of the code examples in the Reference, run:
```sh
mdbook test
```
For authors, consider using the server functionality which supports automatic reload.
To build the Reference locally (in `build/`) and open it in a web
browser, run:
```sh
SPEC_RELATIVE=0 mdbook build --open
```
This will open a browser with a websocket live-link to automatically reload whenever the source is updated.
The `SPEC_RELATIVE=0` environment variable makes links to the standard library go to instead of being relative, which is useful when viewing locally since you normally don't have a copy of the standard library.
You can also use mdbook's live webserver option, which will automatically rebuild the book and reload your web browser whenever a source file is modified:
```sh
SPEC_RELATIVE=0 mdbook serve --open
```