Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rustwasm/book
The Rust and WebAssembly Book
https://github.com/rustwasm/book
mdbook rust rust-wasm wasm
Last synced: 6 days ago
JSON representation
The Rust and WebAssembly Book
- Host: GitHub
- URL: https://github.com/rustwasm/book
- Owner: rustwasm
- License: mit
- Created: 2018-06-06T19:07:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-16T16:03:17.000Z (4 months ago)
- Last Synced: 2024-12-12T11:04:13.374Z (13 days ago)
- Topics: mdbook, rust, rust-wasm, wasm
- Language: Handlebars
- Homepage: https://rustwasm.github.io/docs/book/
- Size: 8.34 MB
- Stars: 1,756
- Watchers: 39
- Forks: 212
- Open Issues: 136
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-list - book
README
The Rust and WebAssembly Book
This small book describes how to use Rust and WebAssembly together. It also consists of tutorials with cool exercises.
Read the Book
|
Contributing
|
Chat
Built with 🦀🕸 by The Rust and WebAssembly Working Group
## About
This repo contains documentation on using Rust for wasm, common workflows, how
to get started and more as you dive deeper. It acts as a guide for doing some really neat things with rust.
If you would like to start learning how to use Rust and WebAssembly together,
you can read the book [online here][book].
[Open issues for improving the Rust and WebAssembly book.][book-issues]
[book-issues]: https://github.com/rustwasm/book/issues
## Building the Book
The book is made using [`mdbook`][mdbook]. To install it you'll need `cargo`
installed. If you don't have any Rust tooling installed, you'll need to install
[`rustup`][rustup] first. Follow the instructions on the site in order to get
setup.
Once you have that done then just do the following:
```bash
$ cargo install mdbook
```
Make sure the `cargo install` directory is in your `$PATH` so that you can run
the binary.
Now just run this command from this directory:
```bash
$ mdbook build
```
This will build the book and output files into a directory called `book`. From
there you can navigate to the `index.html` file to view it in your browser. You
could also run the following command to automatically generate changes if you
want to look at changes you might be making to it:
```bash
$ mdbook serve
```
This will automatically generate the files as you make changes and serves them
locally so you can view them easily without having to call `build` every time.
The files are all written in Markdown so if you don't want to generate the book
to read them then you can read them from the `src` directory.
[mdbook]: https://github.com/rust-lang-nursery/mdBook
[rustup]: https://github.com/rust-lang-nursery/rustup.rs/
[book]: https://rustwasm.github.io/book/game-of-life/introduction.html