-
Notifications
You must be signed in to change notification settings - Fork 30
rustwasm bookshelf #41
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
59060c3
Merge all documentation into one location
alexcrichton 416ef7c
Remove dedicated blog page, put back on main
alexcrichton 78d9cea
create a descriptive bookshelf for rust wasm resources
DebugSteven a4c9d5c
Update docs.md
fitzgen af19898
Update docs.md
fitzgen 7937db0
Update docs.md
fitzgen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,3 +3,8 @@ _site | |
.jekyll-metadata | ||
.bundle | ||
vendor | ||
repos/wasm-bindgen | ||
repos/book | ||
repos/wasm-pack | ||
_site | ||
_build.yml |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
language: rust | ||
|
||
before_install: | ||
- curl -L https://github.com/rust-lang-nursery/mdBook/releases/download/v0.2.1/mdbook-v0.2.1-x86_64-unknown-linux-musl.tar.gz | tar xzf - | ||
- export PATH=$PATH:`pwd` | ||
- bundler install | ||
|
||
script: | ||
- ./ci/build.sh | ||
|
||
deploy: | ||
provider: script | ||
script: curl -LsSf https://git.io/fhJ8n | rustc - && (cd _site && ../rust_out) | ||
skip_cleanup: true | ||
on: | ||
branch: master |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,71 +1,51 @@ | ||
--- | ||
layout: default | ||
unwrapped: true | ||
--- | ||
|
||
<!DOCTYPE html> | ||
<html lang="{{ page.lang | default: site.lang | default: "en" }}"> | ||
|
||
{%- include head.html -%} | ||
|
||
<body> | ||
|
||
{%- include header.html -%} | ||
|
||
<main class="page-content" aria-label="Content"> | ||
<div class="home"> | ||
{%- if page.title -%} | ||
<h1 class="page-heading">{{ page.title }}</h1> | ||
{%- if page.title -%} | ||
<h1 class="page-heading">{{ page.title }}</h1> | ||
{%- endif -%} | ||
|
||
<section id="call-to-action"> | ||
<div class="wrapper"> | ||
<img src="{{ "/assets/wasm-ferris.png" | relative_url }}"/> | ||
<h2>Learn Rust and WebAssembly</h2> | ||
<p> | ||
<a href="docs.html">Read the Rust and WebAssembly documentation</a> to | ||
learn how to design, develop, test, debug, profile, and publish Rust and | ||
WebAssembly libraries and applications. | ||
</p> | ||
<h2>Get Involved</h2> | ||
<p> | ||
<a href="https://github.com/rustwasm/team/blob/master/README.md#get-involved">Join the Rust and WebAssembly domain working group!</a> Help us craft the future of Rust and WebAssembly. | ||
</p> | ||
</div> | ||
</section> | ||
|
||
<div class="wrapper"> | ||
{{ content }} | ||
|
||
{%- if site.posts.size > 0 -%} | ||
<section> | ||
<h2 class="post-list-heading">{{ page.list_title | default: "Blog Posts" }}</h2> | ||
<ul class="post-list"> | ||
{%- for post in site.posts -%} | ||
<li> | ||
{%- assign date_format = site.minima.date_format | default: "%b %-d, %Y" -%} | ||
<span class="post-meta">{{ post.date | date: date_format }}</span> | ||
<h3> | ||
<a class="post-link" href="{{ post.url | relative_url }}"> | ||
{{ post.title | escape }} | ||
</a> | ||
</h3> | ||
{%- if site.show_excerpts -%} | ||
{{ post.excerpt }} | ||
{%- endif -%} | ||
|
||
<section id="call-to-action"> | ||
<div class="wrapper"> | ||
<img src="{{ "/assets/wasm-ferris.png" | relative_url }}"/> | ||
<h2>Learn Rust and WebAssembly</h2> | ||
<p> | ||
<a href="https://rustwasm.github.io/book/">Read the Rust and WebAssembly book</a> to | ||
learn how to design, develop, test, debug, profile, and publish Rust and | ||
WebAssembly libraries and applications. | ||
</p> | ||
<h2>Get Involved</h2> | ||
<p> | ||
<a href="https://github.com/rustwasm/team/blob/master/README.md#get-involved">Join the Rust and WebAssembly domain working group!</a> Help us craft the future of Rust and WebAssembly. | ||
</p> | ||
</div> | ||
</section> | ||
|
||
{{ content }} | ||
|
||
<div class="wrapper"> | ||
{%- if site.posts.size > 0 -%} | ||
<section> | ||
<h2 class="post-list-heading">{{ page.list_title | default: "Blog Posts" }}</h2> | ||
<ul class="post-list"> | ||
{%- for post in site.posts -%} | ||
<li> | ||
{%- assign date_format = site.minima.date_format | default: "%b %-d, %Y" -%} | ||
<span class="post-meta">{{ post.date | date: date_format }}</span> | ||
<h3> | ||
<a class="post-link" href="{{ post.url | relative_url }}"> | ||
{{ post.title | escape }} | ||
</a> | ||
</h3> | ||
{%- if site.show_excerpts -%} | ||
{{ post.excerpt }} | ||
{%- endif -%} | ||
</li> | ||
{%- endfor -%} | ||
</ul> | ||
|
||
<p class="rss-subscribe">subscribe <a href="{{ "/feed.xml" | relative_url }}">via RSS</a></p> | ||
</section> | ||
{%- endif -%} | ||
</div> | ||
</div> | ||
</main> | ||
|
||
{%- include footer.html -%} | ||
|
||
{%- include analytics.html -%} | ||
|
||
</body> | ||
|
||
</html> | ||
</li> | ||
{%- endfor -%} | ||
</ul> | ||
|
||
<p class="rss-subscribe">subscribe <a href="{{ "/feed.xml" | relative_url }}">via RSS</a></p> | ||
</section> | ||
{%- endif -%} | ||
</div> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
#!/bin/sh | ||
set -ex | ||
|
||
mkdir -p repos | ||
|
||
if [ ! -d repos/wasm-bindgen ]; then | ||
git clone https://github.com/rustwasm/wasm-bindgen repos/wasm-bindgen | ||
fi | ||
if [ ! -d repos/wasm-pack ]; then | ||
git clone https://github.com/rustwasm/wasm-pack repos/wasm-pack | ||
fi | ||
if [ ! -d repos/book ]; then | ||
git clone https://github.com/rustwasm/book repos/book | ||
fi | ||
|
||
wasm_bindgen_tag=$(cd repos/wasm-bindgen && git describe --abbrev=0 --tags) | ||
wasm_pack_tag=$(cd repos/wasm-pack && git describe --abbrev=0 --tags) | ||
|
||
(cd repos/wasm-bindgen && git reset --hard $wasm_bindgen_tag) | ||
(cd repos/wasm-pack && git reset --hard $wasm_pack_tag) | ||
|
||
wasm_pack_publish_date=$(date -d "@$(cd repos/wasm-pack && git show -s --format=%at)" "+%b %e") | ||
|
||
echo "wasm-pack-tag: $wasm_pack_tag" >> _build.yml | ||
echo "wasm-pack-publish-date: $wasm_pack_publish_date" >> _build.yml | ||
|
||
bundler exec jekyll build --config _config.yml,_build.yml | ||
|
||
mkdir -p _site/docs | ||
mdbook build repos/wasm-bindgen/guide | ||
mv repos/wasm-bindgen/guide/book _site/docs/wasm-bindgen | ||
|
||
mdbook build repos/wasm-pack/docs | ||
mv repos/wasm-pack/docs/book _site/docs/wasm-pack | ||
|
||
mdbook build repos/book | ||
mv repos/book/book _site/docs/book | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
% Rust and WebAssembly Documentation | ||
|
||
<style> | ||
nav { | ||
display: none; | ||
} | ||
#search-input { | ||
width: calc(100% - 58px); | ||
} | ||
#search-but { | ||
cursor: pointer; | ||
} | ||
#search-but, #search-input { | ||
padding: 4px; | ||
border: 1px solid #ccc; | ||
border-radius: 3px; | ||
outline: none; | ||
font-size: 0.7em; | ||
background-color: #fff; | ||
} | ||
#search-but:hover, #search-input:focus { | ||
border-color: #55a9ff; | ||
} | ||
h2 { | ||
font-size: 18px; | ||
} | ||
</style> | ||
|
||
Welcome to an overview of the documentation provided by the [Rust | ||
WebAssembly Working Group](https://github.com/rustwasm). All of these | ||
projects are managed by the working group; there are other unofficial | ||
documentation resources as well! | ||
|
||
Many of these resources take the form of "books"; we collectively call | ||
these "The Rust WebAssembly Bookshelf." Some are large, some are small. | ||
DebugSteven marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
# Learn about Rust and WebAssembly | ||
|
||
If you'd like to learn about Rust and WebAssembly, this is the spot for | ||
you! All of these resources assume that you have programmed a little bit | ||
of Rust and that you have some familiarity with JavaScript. If you want | ||
to learn how to use Rust in your web browser, these resources are a | ||
great place to get started: | ||
|
||
## The Rust Wasm Book | ||
|
||
[The Rust Wasm Book](docs/book) describes how to use Rust and | ||
WebAssembly together. There's a tutorial to create an end to end project | ||
using Rust and WebAssembly and finally the book concludes with reference | ||
sections full of general, good to know, information, to explore more | ||
DebugSteven marked this conversation as resolved.
Show resolved
Hide resolved
|
||
with Rust and WebAssembly. | ||
|
||
# Dive Into Rust and WebAssembly | ||
|
||
If you'd like a deeper dive into Rust and WebAssembly, these resources | ||
are for you. These books are good to look into after you've gone through | ||
the tutorial in [The Rust Wasm Book](docs/book) or you already have some | ||
familiarity with Rust, WebAssembly, and JavaScript. These books go into | ||
more depth about the Rust WebAssesmbly tools and crates. | ||
|
||
## The `wasm-bindgen` Guide | ||
|
||
[The `wasm-bindgen` Guide](docs/wasm-bindgen) covers the `wasm-bindgen` | ||
tool and crate. `wasm-bindgen` is a Rust library and CLI tool that | ||
facilitate high-level interactions between wasm modules and JavaScript. | ||
This is great to read if you're seeking more information about how | ||
`wasm-bindgen` works, what more you can do with it, and other references | ||
for the `wasm-bindgen` tool and related crates. There's also information | ||
on how you can contribute to the `wasm-bindgen` tool, if you're | ||
curious. | ||
|
||
## The `wasm-pack` Book | ||
|
||
[The `wasm-pack` Book](docs/wasm-pack) covers the Rust to WebAssembly | ||
workflow tool. This book covers prerequistes, project setup, and | ||
available commands for `wasm-pack`. The `wasm-pack` book has quick start | ||
guides to using generated templates and highlights how the workflow with | ||
those templates works so you can get a working Rust and WebAssembly | ||
project up, running, and deployed fast. If you're interested in | ||
contributing to `wasm-pack`, you will find all that information at the | ||
end of this book too! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.