This is the source code of the Rust by example website!

See CONTRIBUTING.md.

First, make certain you install nodejs on Debian based distributions, or node on non-Debian distros. After installation, if you use a Debian based distro (i.e. Ubuntu), run

sudo ln -s /usr/bin/nodejs /usr/bin/node

Then run

make all
make book
make test

View the results with make serve.

We use these tools to generate the static site:

• Rust \o/
• gitbook

gitbook will generate the site from markdown files (see details about how it works [here][gitbook-format]).

Before running gitbook, we do a preprocessing step using src/main.rs.

This preprocessing has two steps:

SUMMARY.md is generated from the examples/structure.json file. This JSON file contains a tree-like structure of "examples".

Each example has:

• an id, e.g. hello
• a title, e.g. Hello World
• optionally, children, which is a vector of sub-examples, e.g. null
• a directory under examples, e.g. examples/hello
• an entry in examples/structure.json, e.g. { "id": "hello", "title": "Hello World", "children": null }
• some source file(s), e.g. examples/hello/hello.rs
• an input markdown file, e.g. examples/hello/input.md

When dealing with a child example, the path will have to include the id of its ancestors; e.g. examples/variable/mut/input.md, implies that a mut example lives under the variable example.

Instead of including the rust code directly in input.md, the code lives in separate source files; and the preprocessing step will insert the source code in the markdown file.

For example, to insert the source code of the hello.rs file, the following syntax is used in the markdown file:

• {hello.play} expands the source code embedded in a live code editor
• {hello.rs} expands to static/plain source code.
• {hello.out} expands to the output of executing the source code.

The Makefile provides the following recipes:

• make: builds update.rs and does the preprocessing step
• make book: runs gitbook to generate the book
• make serve: runs gitbook --serve to generate the book and publishes it under localhost:4000
• make test: will check all the rust source files for compilation errors

Rust by example is dual licensed under the Apache 2.0 license and the MIT license.

See LICENSE-APACHE and LICENSE-MIT for more details.