Skip to content

Commit

Permalink
talk about --resource-suffix
Browse files Browse the repository at this point in the history
  • Loading branch information
QuietMisdreavus committed Mar 16, 2018
1 parent 6b29060 commit b5ab5ce
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions src/doc/rustdoc/src/unstable-features.md
Expand Up @@ -316,3 +316,16 @@ $ rustdoc -Z unstable-options --theme-checker theme.css
Before including your theme in crate docs, `rustdoc` will compare all the CSS rules it contains
against the "main" theme included by default. Using this flag will allow you to see which rules are
missing if `rustdoc` rejects your theme.

### `--resource-suffix`: modifying the name of CSS/JavaScript in crate docs

Using this flag looks like this:

```bash
$ rustdoc src/lib.rs -Z unstable-options --resource-suffix suf
```

When rendering docs, `rustdoc` creates several CSS and JavaScript files as part of the output. Since
all these files are linked from every page, changing where they are can be cumbersome if you need to
specially cache them. This flag will rename all these files in the output to include the suffix in
the filename. For example, `main.css` would become `main-suf.css` with the above command.

0 comments on commit b5ab5ce

Please sign in to comment.