Skip to content

fix(previewer): mark @example and @default code blocks as TS #918

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

Merged
merged 1 commit into from
Sep 30, 2024

Conversation

ribru17
Copy link
Contributor

@ribru17 ribru17 commented Sep 27, 2024

When interpreting the preview result as Markdown, it is quite helpful to have the typescript language annotation before @example code blocks because it will give code highlights and make it more clear that this is an example of code rather than just raw text.

When interpreting the preview result as Markdown, it is quite helpful to
have the `typescript` language annotation before `@example` code blocks
because it will give code highlights and make it more clear that this is
an example of code rather than just raw text.
Copy link
Member

@rchl rchl left a comment

Choose a reason for hiding this comment

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

Nothing really guarantees that it will be a typescript snippet but I guess it might be in majority of cases.

@rchl rchl changed the title fix(previewer): mark @example code blocks as typescript fix(previewer): mark @example and @default code blocks as TS Sep 30, 2024
@rchl rchl merged commit 184c60d into typescript-language-server:master Sep 30, 2024
7 of 8 checks passed
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.

2 participants