Skip to content
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.

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

allow automatic toc #5816

Closed
wants to merge 1 commit into from
Closed

Conversation

tshepang
Copy link
Contributor

@tshepang tshepang commented Feb 3, 2023

toc

will add this to CI if so desired, so that those not running mdbook locally see all the pretty

@archseer
Copy link
Member

archseer commented Feb 4, 2023

That won't work out of the box, we don't have the mdbook-toc binary.

@tshepang
Copy link
Contributor Author

tshepang commented Feb 4, 2023

It does not fail to serve docs if mdbook-doc is not found.

Copy link
Member

@the-mikedavis the-mikedavis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#5534 also adds a toc for the install page and some others. I think it's fine to do this manually since the sections don't change very often

@the-mikedavis the-mikedavis added the A-documentation Area: Documentation improvements label Feb 4, 2023
@archseer
Copy link
Member

archseer commented Mar 8, 2023

Replaced by #5534

@archseer archseer closed this Mar 8, 2023
@tshepang tshepang deleted the automatic-toc branch March 8, 2023 06:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documentation Area: Documentation improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants