Docs: Give headers ids for easy linking #360
Merged
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
|
Discount (a Markdown implementation in C) keeps alnum and https://github.com/Orc/discount/blob/master/mkdio.c#L212-L241 |
|
|
||
| class Redcarpet::Render::HTML | ||
| def header(title, level) | ||
| clean_title = Sanitize.clean(title).downcase.gsub(/\s+/, "-") |
There was a problem hiding this comment.
nit: can you indent it
clean_title = Sanitize.clean(title)
.downcase
.gsub(/\s+/, "-")
.gsub(/[^A-Za-z0-9\-_.]/, "")
|
Accepted :) |
This gives markdown headers an id so that we can link directly to sections of our docs. This is better than the alternative of adding them all ourselves.
bvaughn
pushed a commit
to bvaughn/react
that referenced
this pull request
Aug 13, 2019
* feat: match HOC display names during search * chore: update tests for new search logic
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.
This gives markdown headers an id so that we can link directly to
sections of our docs. This is better than the alternative of adding them
all ourselves.
I think this is better than what @SanderSpies added in #359 (sorry!) and is more maintainable. I tried switching to a different markdown parser (maraku) but it struggled with some of the things we do and I think this is pretty close to what maraku does. I'm actually going to take a look at what it does and maybe get inspired... with fewer additional dependencies.
Don't merge me yet.