rwf2
/
Rocket
mirror of https://github.com/rwf2/Rocket.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Rocket/site
History
Sergio Benitez 41de1e62fb Implement 'Responder' for 'Status'. 
This commit obviates the following removed types:

  * response::Failure
  * response::status::NoContent
  * response::status::Reset

Closes #489.
 		2018-10-31 03:57:22 -07:00
..
guide Implement 'Responder' for 'Status'. 2018-10-31 03:57:22 -07:00
news Fix broken site URLs and typos. 2018-10-16 04:01:17 -07:00
LICENSE Add site contents, including the guide. Add license information. 2017-04-16 21:11:41 -07:00
README.md Version all URLs to 'rocket.rs'. 2018-10-26 21:20:12 -07:00
index.toml Keep release info in site's 'index.toml'. 2018-10-28 20:17:44 -07:00
overview.toml Improve templates guide documentation. 2018-10-26 20:52:28 -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.

Guide Links

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.