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

improvement: Switch to marked to enable links in release notes #1184

Merged
merged 1 commit into from
Oct 12, 2022

Conversation

tgodzik
Copy link
Contributor

@tgodzik tgodzik commented Oct 12, 2022

Previously, if links were clicked that corresponded to header on the same site #title-of-h2 it woukld not work due to missing auto generated id. Now, that works correctly with marked and this seems to be used by VS Code also though it appears to be inlined there:

https://github.com/microsoft/vscode/blob/4affcdb07c275abdf9944180e7c6e3e82ad3edb2/src/vs/base/common/marked/marked.d.ts

@kpodsiad was there any reason for using Remarkable?

@tgodzik tgodzik requested a review from kpodsiad October 12, 2022 11:18
Previously, if links were clicked that corresponded to header on the same site `#title-of-h2` it woukld not work due to missing auto generated id. Now, that works correctly with marked and this seems to be used by VS Code also though it appears to be inlined there:

https://github.com/microsoft/vscode/blob/4affcdb07c275abdf9944180e7c6e3e82ad3edb2/src/vs/base/common/marked/marked.d.ts
Copy link
Member

@kpodsiad kpodsiad left a comment

Choose a reason for hiding this comment

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

I think it was the first npm package that I grabbed, no particular reason

@tgodzik tgodzik merged commit 3e5c6c1 into scalameta:main Oct 12, 2022
@tgodzik tgodzik deleted the marked branch October 12, 2022 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants