Skip to content

Add mdbook-toc #1014

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
4 tasks done
igaray opened this issue Jan 9, 2021 · 1 comment · Fixed by #1028
Closed
4 tasks done

Add mdbook-toc #1014

igaray opened this issue Jan 9, 2021 · 1 comment · Fixed by #1028
Assignees
@igaray

Comments

@igaray
Copy link
Member

igaray commented Jan 9, 2021 •
edited
Loading

mdbook-toc is an mdbook preprocessor that allows auto-generating TOCs. This is useful for long sections with many subtitles.

  • Add the preprocessor configuration to book.toml
  • Add the preprocessor to the CI configuration
  • Add the preprocessor dependency and usage to the instructions on how to contribute to the guide.
  • Identify sections in need of a TOC and add the <!-- toc --> marker
@jyn514
Copy link
Member

jyn514 commented Jan 9, 2021

Related: #853

@igaray igaray self-assigned this Jan 13, 2021
@igaray igaray mentioned this issue Jan 17, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@igaray igaray

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add mdbook-toc, markers, and documentation igaray/rustc-dev-guide
2 participants
@igaray @jyn514