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

Add ToC to larger doc pages #1555

Merged
merged 1 commit into from Nov 26, 2018
Merged

Add ToC to larger doc pages #1555

merged 1 commit into from Nov 26, 2018

Conversation

@hiddeco
Copy link
Member

hiddeco commented Nov 25, 2018

Closes #1546

Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco hiddeco added the docs label Nov 25, 2018
@hiddeco hiddeco requested a review from dholbach Nov 25, 2018
Copy link
Contributor

dholbach left a comment

This is great. Thanks @hiddeco! Let's land this!

Did you generate the ToC somehow, so we could script this (in a way?) and make sure it doesn't get out of sync with reality?

@hiddeco

This comment has been minimized.

Copy link
Member Author

hiddeco commented Nov 26, 2018

@dholbach I used markdown-toc and a good old Ctrl C + Ctrl V to get us started.

Automating this should however be possible by leveraging the <!-- toc --><!-- tocstop --> comments.

@dholbach

This comment has been minimized.

Copy link
Contributor

dholbach commented Nov 26, 2018

Excellent! Let's do this separately some time later then!

@hiddeco hiddeco merged commit e988196 into master Nov 26, 2018
1 check passed
1 check passed
ci/circleci: build Your tests passed on CircleCI!
Details
@hiddeco hiddeco deleted the 1546-toc-docs branch Nov 26, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.