Skip to content

Commit

Permalink
Add documentation for index-page features
Browse files Browse the repository at this point in the history
  • Loading branch information
GuillaumeGomez committed Nov 1, 2018
1 parent a40b758 commit 1244a85
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 @@ -389,3 +389,16 @@ pub struct BigX;

Then, when looking for it through the `rustdoc` search, if you enter "x" or
"big", search will show the `BigX` struct first.

### `--index-page`: provide a top-level landing page for docs

This feature allows you to generate an index-page with a given markdown file. A good example of it
is the [rust documentation index](https://doc.rust-lang.org/index.html).

With this, you'll have a page which you can custom as much as you want at the top of your crates.

Using `index-page` option enables `enable-index-page` option as well.

### `--enable-index-page`: generate a default index page for docs

This feature allows the generation of a default index-page which lists the generated crates.

0 comments on commit 1244a85

Please sign in to comment.