-
-
Notifications
You must be signed in to change notification settings - Fork 8.5k
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
fix: replace apostrophe with empty string in header slugification #1618
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
This change is to replicate the github behviour with respect to apostrophe in headers. When there is an apostrophe in a header, github replaces it with empty string when creating an anchor link to that header. Docusaurus should follow the same convention.
Deploy preview for docusaurus-2 ready! Built with commit 51b8287 |
Deploy preview for docusaurus-preview ready! Built with commit 51b8287 |
yangshun
changed the title
Replace apostrophe with empty string in header to replicate GitHub behaviour
fix: replace apostrophe with empty string in header slugification
Jun 22, 2019
yangshun
approved these changes
Jun 22, 2019
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, thanks! I've added the typical apostrophe ('
) to that regexp as well
…saurus into parthpp-apostropheHeaderFix
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 change is to replicate the github behaviour with respect to apostrophe in
headers. When there is an apostrophe in a header, github replaces it with empty string
when creating an anchor link to that header. Docusaurus should follow the same convention.
We are facing some problems because of this inconsistency.
Have you read the Contributing Guidelines on pull requests?
Yes