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

[docs] Change goldmark autoHeadingIDType to blackfriday #4132

Merged
merged 1 commit into from
Apr 2, 2020
Merged

[docs] Change goldmark autoHeadingIDType to blackfriday #4132

merged 1 commit into from
Apr 2, 2020

Conversation

stevebang
Copy link
Contributor

Previous blackFriday Markdown render engine handled header link IDs differently. The newer goldmark, by default, uses GFM (github) to auto-create IDs. That's likely better, but too many links would need to be updated to use the github behavior. This change preserves the old ID behavior for now, until we can update the links and teach everyone the differences.

For details, see https://gohugo.io/getting-started/configuration-markup#goldmark

@stevebang stevebang added the area/documentation Documentation needed label Apr 1, 2020
@stevebang stevebang requested a review from andrewc-dev April 1, 2020 22:37
@yugabyte-ci
Copy link
Contributor

Can one of the admins verify this patch?

Copy link
Contributor

@andrewc-dev andrewc-dev left a comment

Choose a reason for hiding this comment

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

LG

@stevebang stevebang merged commit 327aed1 into yugabyte:master Apr 2, 2020
@stevebang stevebang deleted the goldmark-auto-heading-update branch April 2, 2020 19:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Documentation needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants