Use markdown-toc #524
Merged
Use markdown-toc #524
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JoelMarcey
approved these changes
Apr 4, 2018
There was a problem hiding this comment.
@microbouji Hi. Sorry for the delay here. I just got back from vacation. This looks great, thanks!
I think we will also need to add a package-lock.json update as well.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
This adds the markdown-toc library from the author of remarkable to handle TOC generation. It is much more robust than the solution I'd implemented myself. For example it handles correctly markup including links in headings so things like this don't happen: babel/website#1614 and many more edge cases I had not considered.
Have you read the Contributing Guidelines on pull requests?
yes
Test Plan
In the second commit I'm also rendering markdown backticks in the nav headings into html code tags. So this nav from the cli commands page for examlpe will change like this from left(before) to right(after):
Related PRs