1# Rocket Website Source 2 3This directory contains the source files for the content on [Rocket's 4website](https://rocket.rs). 5 6## Contents 7 8This directory contains the following: 9 10 * `index.toml` - Source data for the index. 11 * `overview.toml` - Source data for the overview page (`overview/`). 12 * `news/index.toml` - Source data for the news page (`news/`). 13 * `news/*.md` - News articles linked to from `news/index.toml`. 14 * `guide/*.md` - Guide pages linked to from `guide.md`. 15 16[Rocket Programming Guide]: https://rocket.rs/v0.5/guide/ 17 18### Guide Links 19 20Cross-linking guide pages is accomplished via relative links. Outside of the 21index, this is: `../{page}#anchor`. For instance, to link to the **Quickstart > 22Running Examples** page, use `../quickstart#running-examples`. 23 24### Aliases 25 26Aliases are shorthand URLs that start with `@` (e.g, `@api`). They are used 27throughout the guide to simplify versioning URLs to Rocket's source code and the 28Rocket API. They are replaced at build time with a URL prefix. At present, the 29following aliases are available, where `${version}` is Rocket's version string 30at the time of compilation: 31 32 * `@example`: https://github.com/SergioBenitez/Rocket/tree/${version}/examples 33 * `@github`: https://github.com/SergioBenitez/Rocket/tree/${version} 34 * `@api`: https://api.rocket.rs/${version} 35 36For example, to link to `Rocket::launch()`, you might write: 37 38```md 39Launch an instance of your application using the [`launch()`] method. 40 41[`launch()`]: @api/rocket/struct.Rocket.html#method.launch 42``` 43 44## License 45 46The Rocket website source is licensed under the [GNU General Public License v3.0](LICENSE). 47