Skip to content

Commit 78d9cea

Browse files
committed
create a descriptive bookshelf for rust wasm resources
1 parent 416ef7c commit 78d9cea

File tree

1 file changed

+81
-3
lines changed

1 file changed

+81
-3
lines changed

docs.md

Lines changed: 81 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,81 @@
1-
* [The rustwasm book](docs/book)
2-
* [The wasm-bindgen book](docs/wasm-bindgen)
3-
* [The wasm-pack book](docs/wasm-pack)
1+
% Rust and WebAssembly Documentation
2+
3+
<style>
4+
nav {
5+
display: none;
6+
}
7+
#search-input {
8+
width: calc(100% - 58px);
9+
}
10+
#search-but {
11+
cursor: pointer;
12+
}
13+
#search-but, #search-input {
14+
padding: 4px;
15+
border: 1px solid #ccc;
16+
border-radius: 3px;
17+
outline: none;
18+
font-size: 0.7em;
19+
background-color: #fff;
20+
}
21+
#search-but:hover, #search-input:focus {
22+
border-color: #55a9ff;
23+
}
24+
h2 {
25+
font-size: 18px;
26+
}
27+
</style>
28+
29+
Welcome to an overview of the documentation provided by the [Rust
30+
WebAssembly Working Group](https://github.com/rustwasm). All of these
31+
projects are managed by the working group; there are other unofficial
32+
documentation resources as well!
33+
34+
Many of these resources take the form of "books"; we collectively call
35+
these "The Rust WebAssembly Bookshelf." Some are large, some are small.
36+
37+
# Learn about Rust and WebAssembly
38+
39+
If you'd like to learn about Rust and WebAssembly, this is the spot for
40+
you! All of these resources assume that you have programmed a little bit
41+
of Rust and that you have some familiarity with JavaScript. If you want
42+
to learn how to use Rust in your web browser, these resources are a
43+
great place to get started:
44+
45+
## The Rust Wasm Book
46+
47+
[The Rust Wasm Book](docs/book) describes how to use Rust and
48+
WebAssembly together. There's a tutorial to create an end to end project
49+
using Rust and WebAssembly and finally the book concludes with reference
50+
sections full of general, good to know, information, to explore more
51+
with Rust and WebAssembly.
52+
53+
# Dive Into Rust and WebAssembly
54+
55+
If you'd like a deeper dive into Rust and WebAssembly, these resources
56+
are for you. These books are good to look into after you've gone through
57+
the tutorial in [The Rust Wasm Book](docs/book) or you already have some
58+
familiarity with Rust, WebAssembly, and JavaScript. These books go into
59+
more depth about the Rust WebAssesmbly tools and crates.
60+
61+
## The `wasm-bindgen` Guide
62+
63+
[The `wasm-bindgen` Guide](docs/wasm-bindgen) covers the `wasm-bindgen`
64+
tool and crate. `wasm-bindgen` is a Rust library and CLI tool that
65+
facilitate high-level interactions between wasm modules and JavaScript.
66+
This is great to read if you're seeking more information about how
67+
`wasm-bindgen` works, what more you can do with it, and other references
68+
for the `wasm-bindgen` tool and related crates. There's also information
69+
on how you can contribute to the `wasm-bindgen` tool, if you're
70+
curious.
71+
72+
## The `wasm-pack` Book
73+
74+
[The `wasm-pack` Book](docs/wasm-pack) covers the Rust to WebAssembly
75+
workflow tool. This book covers prerequistes, project setup, and
76+
available commands for `wasm-pack`. The `wasm-pack` book has quick start
77+
guides to using generated templates and highlights how the workflow with
78+
those templates works so you can get a working Rust and WebAssembly
79+
project up, running, and deployed fast. If you're interested in
80+
contributing to `wasm-pack`, you will find all that information at the
81+
end of this book too!

0 commit comments

Comments
 (0)