45b4436ed3
The bulk of the changes in this commit are for creating an 'ErrorHandler' trait that works like the 'Handler' trait, but for errors. Furthermore, Rocket's default catcher now responds with a JSON payload if the preferred 'Accept' media type is JSON. This commit also fixes a bug in 'LocalRequest' where the internal 'Request' contained an correct 'URI'. |
||
---|---|---|
.. | ||
guide | ||
news | ||
tests | ||
index.toml | ||
LICENSE | ||
overview.toml | ||
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 fromnews/index.toml
.guide/*.md
- Guide pages linked to fromguide.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:
@example
: https://github.com/SergioBenitez/Rocket/tree/${version}/examples@github
: https://github.com/SergioBenitez/Rocket/tree/${version}@api
: https://api.rocket.rs/${version}
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.