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

monaco-json hover provider not interpreting markdown #1816

Closed
gempain opened this issue Feb 6, 2020 · 2 comments
Closed

monaco-json hover provider not interpreting markdown #1816

gempain opened this issue Feb 6, 2020 · 2 comments
Assignees
Labels

Comments

@gempain
Copy link

gempain commented Feb 6, 2020

Related to:

The default JSON hover from monaco-json displays the JSON schema definition description corresponding to the hovered property. When the description contains markdown, it is interpreted as raw text. I am assuming this is due to the isTrusted property of Hover being set to false. Surprisingly, indents of 4 spaces are interpreted as code blocks.

Would it be possible to trust the JSON schema description ? Is this a bug or an intended feature ?

Keep up the great work !

@aeschli
Copy link
Contributor

aeschli commented Feb 10, 2020

As description is part of the standard JSON schema format we assume it is raw text.
For markdown descriptions, the VSCode/MonacoJSON language service looks for the property markdownDescription. That's not standardized, but if you don't mind, use it.

@aeschli aeschli closed this as completed Feb 10, 2020
@gempain
Copy link
Author

gempain commented Feb 10, 2020

@aeschli thanks for the tip ! I didn't find this in the docs, but am glad to see this feature already exists.

@vscodebot vscodebot bot locked and limited conversation to collaborators Mar 26, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

3 participants