Merge pull request #635 from fitzgen/organize-docs-into-tour-and-reference

guide: Organize docs into "Whirlwind Tour" and "Reference" sections
This commit is contained in:
Nick Fitzgerald 2018-08-03 16:26:59 -07:00 committed by GitHub
commit 94fe55ce80
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 30 additions and 9 deletions

View File

@ -4,15 +4,17 @@
--------------------------------------------------------------------------------
- [Basic Usage](./basic-usage.md)
- [What Just Happened?](./what-just-happened.md)
- [What Else Can We Do?](./what-else-can-we-do.md)
- [Closures](./closures.md)
- [No ES Modules](./no-esm.md)
- [Passing Arbitrary data](./passing-data.md)
- [Feature Reference](./feature-reference.md)
- [CLI Reference](./cli-reference.md)
- [Type Reference](./reference.md)
- [Whirlwind Tour](./whirlwind-tour/introduction.md)
- [Basic Usage](./whirlwind-tour/basic-usage.md)
- [What Just Happened?](./whirlwind-tour/what-just-happened.md)
- [What Else Can We Do?](./whirlwind-tour/what-else-can-we-do.md)
- [Reference](./reference/index.md)
- [Closures](./reference/closures.md)
- [No ES Modules](./reference/no-esm.md)
- [Passing Arbitrary data](./reference/passing-data.md)
- [Feature Reference](./reference/feature-reference.md)
- [CLI Reference](./reference/cli-reference.md)
- [Type Reference](./reference/reference.md)
--------------------------------------------------------------------------------

View File

@ -0,0 +1,10 @@
# Reference
This section contains reference material for using `wasm-bindgen`. It is not
intended to be read start to finish. Instead, it aims to quickly answer
questions like:
* Is type X supported as a parameter in a Rust function exported to JavaScript?
* What was that CLI flag to disable ECMAScript modules output, and instead
attach the JavaScript bindings directly to `window`?

View File

@ -0,0 +1,9 @@
# A Whirlwind Tour of `wasm-bindgen`
What follows is a whirlwind tour of `wasm-bindgen`.
You will learn:
* Setting up your development environment for `wasm-bindgen`
* Importing JavaScript functions and classes into Rust
* Exporting Rust structs and functions to JavaScript