microsoft / microsoft/monaco-editor
Allow HTML in documentation of CompletionItem
Open
@jrieken is already working on this.
Since Aug 3, 2022.
feature-request
suggest
- Dominant language
- JavaScript
- Stars
- 46.8k
- Forks
- 4.1k
- Avg merge
- 17h 58m
- Merged PRs (30d)
- 1
Description
Feature Request
The documentation parameter of a CompletionItem can only be a string, or a IMarkdownString.
It seems simple strings are escaped, and HTML tags are removed from the value of IMarkdownString.
I suggest an extra parameter in CompletionItem called documentationIsSafe, where if truthy the documentation is not escaped, or a new IHTMLString documentation type.
Similarly, addExtraLib should also allow inline documentation of a typescript definition file to include HTML, and render it as such.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.