File tree Expand file tree Collapse file tree 1 file changed +13
-0
lines changed Expand file tree Collapse file tree 1 file changed +13
-0
lines changed Original file line number Diff line number Diff line change @@ -389,3 +389,16 @@ pub struct BigX;
389
389
390
390
Then, when looking for it through the ` rustdoc ` search, if you enter "x" or
391
391
"big", search will show the ` BigX ` struct first.
392
+
393
+ ### ` --index-page ` : provide a top-level landing page for docs
394
+
395
+ This feature allows you to generate an index-page with a given markdown file. A good example of it
396
+ is the [ rust documentation index] ( https://doc.rust-lang.org/index.html ) .
397
+
398
+ With this, you'll have a page which you can custom as much as you want at the top of your crates.
399
+
400
+ Using ` index-page ` option enables ` enable-index-page ` option as well.
401
+
402
+ ### ` --enable-index-page ` : generate a default index page for docs
403
+
404
+ This feature allows the generation of a default index-page which lists the generated crates.
You can’t perform that action at this time.
0 commit comments