Skip to content

Commit c21b275

Browse files
committed
rustdoc: document --default-theme option in command line doc
Signed-off-by: Ian Jackson <[email protected]>
1 parent 36ee3bd commit c21b275

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

src/doc/rustdoc/src/command-line-arguments.md

+20
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,26 @@ for a target triple that's different than your host triple.
237237

238238
All of the usual caveats of cross-compiling code apply.
239239

240+
## `--default-theme`: set the default theme
241+
242+
Using this flag looks like this:
243+
244+
```bash
245+
$ rustdoc src/lib.rs --default-theme=ayu
246+
```
247+
248+
Sets the default theme (for users whose browser has not remembered a
249+
previous theme selection from the on-page theme picker).
250+
251+
The supplied value should be the lowercase version of the theme name.
252+
The set of available themes can be seen in the theme picker in the
253+
gneerated output.
254+
255+
Note that the set of available themes - and their appearance - is not
256+
necessarily stable from one rustdoc version to the next. If the
257+
requested theme does not exist, the builtin default (currently
258+
`light`) is used instead.
259+
240260
## `--markdown-css`: include more CSS files when rendering markdown
241261

242262
Using this flag looks like this:

0 commit comments

Comments
 (0)