Skip to content
This repository has been archived by the owner on Nov 1, 2022. It is now read-only.

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 hiddeco commented Nov 25, 2018

Closes #1546

@hiddeco
Add ToC to larger doc pages
4e01457 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco hiddeco added the docs Issue or PR relates to documentation label Nov 25, 2018
dholbach
dholbach approved these changes Nov 26, 2018
View reviewed changes
Copy link
Member

@dholbach dholbach left a comment

Choose a reason for hiding this comment

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

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
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
Copy link
Member

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

@hiddeco hiddeco merged commit e988196 into master Nov 26, 2018
@hiddeco hiddeco deleted the 1546-toc-docs branch November 26, 2018 09:19
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@dholbach dholbach dholbach approved these changes

Assignees
No one assigned
Labels
docs Issue or PR relates to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@hiddeco @dholbach