This is the source code of the Rust by example website!
See CONTRIBUTING.md.
We use these tools to generate the static site:
gitbook will generate the site from markdown files (see details about how it
works here).
Before running gitbook, we do a preprocessing step using
src/update.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: buildsupdate.rsand does the preprocessing stepmake book: runsgitbookto generate the bookmake serve: runsgitbook --serveto generate the book and publishes it underlocalhost:4000make 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.