diff options
| author | Tshepang Mbambo <hopsi@tuta.io> | 2025-08-03 06:55:44 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-08-03 06:55:44 +0200 |
| commit | 3bba46bb5242e2b32c9e48eaedcea1d55f9ebb2a (patch) | |
| tree | 71ce326c3053c1c4a257bb72ce11f682eb55726c /src/doc/rustc-dev-guide/README.md | |
| parent | 700e063e7ed65307371adb0177f1c1312a14c96c (diff) | |
| parent | 65589ad33f544003e49cabeb0b76f6b1f0d3ce30 (diff) | |
Merge pull request #2509 from rust-lang/tshepang-auto-toc
make toc generation fully automatic
Diffstat (limited to 'src/doc/rustc-dev-guide/README.md')
| -rw-r--r-- | src/doc/rustc-dev-guide/README.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/src/doc/rustc-dev-guide/README.md b/src/doc/rustc-dev-guide/README.md index 5932da467ab..1ad895aeda2 100644 --- a/src/doc/rustc-dev-guide/README.md +++ b/src/doc/rustc-dev-guide/README.md @@ -43,7 +43,7 @@ rustdocs][rustdocs]. To build a local static HTML site, install [`mdbook`](https://github.com/rust-lang/mdBook) with: ``` -cargo install mdbook mdbook-linkcheck2 mdbook-toc mdbook-mermaid +cargo install mdbook mdbook-linkcheck2 mdbook-mermaid ``` and execute the following command in the root of the repository: @@ -67,8 +67,8 @@ ENABLE_LINKCHECK=1 mdbook serve ### Table of Contents -We use `mdbook-toc` to auto-generate TOCs for long sections. You can invoke the preprocessor by -including the `<!-- toc -->` marker at the place where you want the TOC. +Each page has a TOC that is automatically generated by `pagetoc.js`. +There is an associated `pagetoc.css`, for styling. ## Synchronizing josh subtree with rustc |