Rocket/site
Sergio Benitez 124ec94b46 Fix typos.
Co-authored-by: cui fliter <imcusg@gmail.com>
2023-11-17 17:04:49 +01:00
..
guide Fix typos. 2023-11-17 17:04:49 +01:00
news Fix typos. 2023-11-17 17:04:49 +01:00
tests New version: 0.5.0-rc.4. 2023-11-17 17:04:44 +01:00
LICENSE Add site contents, including the guide. Add license information. 2017-04-16 21:11:41 -07:00
README.md New version: 0.5.0-rc.1. 2021-06-09 09:52:37 -07:00
index.toml New version: 0.5.0-rc.4. 2023-11-17 17:04:44 +01:00
overview.toml Fix spacing in 'overview' code examples. 2022-02-23 14:23:35 -08: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.