Rocket/site
Sergio Benitez c74bcfd40a Graduate contrib 'json' and 'msgpack' into core.
This has the following nice benefits:

  * The 'JsonValue' wrapper type is gone.
  * 'Local{Request, Response}' natively support JSON/MessagePack.
  * The 'json' and 'msgpack' limits are officially recognized.
  * Soon, Rocket application will not require an explicit 'serde' dep.

This marks the beginning of the end of 'rocket_contrib'.
2021-05-22 11:01:00 -07:00
..
guide Graduate contrib 'json' and 'msgpack' into core. 2021-05-22 11:01:00 -07:00
news Fix various typos throughout the codebase. 2020-07-22 12:56:01 -07:00
tests Graduate contrib 'json' and 'msgpack' into core. 2021-05-22 11:01:00 -07:00
LICENSE Add site contents, including the guide. Add license information. 2017-04-16 21:11:41 -07:00
README.md Point all docs and doc links to 'master' branch. 2020-10-21 04:54:24 -07:00
index.toml Update examples on site index and overview. 2021-04-14 22:17:15 -07:00
overview.toml Update examples on site index and overview. 2021-04-14 22:17:15 -07:00

README.md

Rocket Website Source

This directory contains the source files for the content on Rocket's website.

Contents

This directory contains the following:

  • index.toml - Source data for the index.
  • overview.toml - Source data for the overview page (overview/).
  • news/index.toml - Source data for the news page (news/).
  • news/*.md - News articles linked to from news/index.toml.
  • guide/*.md - Guide pages linked to from guide.md.

Cross-linking guide pages is accomplished via relative links. Outside of the index, this is: ../{page}#anchor. For instance, to link to the Quickstart > Running Examples page, use ../quickstart#running-examples.

Aliases

Aliases are shorthand URLs that start with @ (e.g, @api). They are used throughout the guide to simplify versioning URLs to Rocket's source code and the Rocket API. They are replaced at build time with a URL prefix. At present, the following aliases are available, where ${version} is Rocket's version string at the time of compilation:

For example, to link to Rocket::launch(), you might write:

Launch an instance of your application using the [`launch()`] method.

[`launch()`]: @api/rocket/struct.Rocket.html#method.launch

License

The Rocket website source is licensed under the GNU General Public License v3.0.