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

Support extended Markdown API for MarkedString during Hover #32205

Closed
FabienPean opened this issue Aug 9, 2017 · 3 comments
Closed

Support extended Markdown API for MarkedString during Hover #32205

FabienPean opened this issue Aug 9, 2017 · 3 comments
Assignees
Labels
feature-request Request for new features or functionality markdown Markdown support issues under-discussion Issue is under discussion for relevance, priority, approach

Comments

@FabienPean
Copy link

  • VSCode Version: 0.15
  • OS Version: Windows 10 Pro x64

With the new Markdown API, one can extend the markdown engine of vscode to render things like equations using the katex or mathjax markdown-it plugin in the markdown preview window of a file.

However, after some test on the latest insider, I could not make the system of markdown-it extension work when using the hover function in the editor to render what the API calls "MarkedString".

This would be beneficial for many reasons, specifically in my case, when there are mathematical equations in comments formatted in latex.

This is somewhat related to #11877 #21141 #17298 #1920. Feel free to close it if it is considered as duplicate.

@vscodebot vscodebot bot added the markdown Markdown support issues label Aug 9, 2017
@mjbvz mjbvz self-assigned this Aug 10, 2017
@mjbvz mjbvz added feature-request Request for new features or functionality under-discussion Issue is under discussion for relevance, priority, approach labels Aug 10, 2017
@mjbvz
Copy link
Collaborator

mjbvz commented Aug 10, 2017

The new markdown API is an API exposed by the markdown extension. The core editor has no knowledge of this API and uses a completely different engine for rendering markdown.

I don't think allowing extending MarkedString in a manner akin to the markdown API is something we'd ever really want to support, and certainly not the css and script contributions.

For this case, can you preprocess the markdown to convert mathematical equations into images?

@mjbvz
Copy link
Collaborator

mjbvz commented Aug 18, 2017

Closing this for now. Allowing extensions to provide richer docs/hover content is an interesting idea but I don't think markdown extensions are how we want to go about supporting this

@mjbvz mjbvz closed this as completed Aug 18, 2017
@FabienPean
Copy link
Author

I was giving a try with potential options. Unfortunately, I could not make anything really working, and which would be convenient.

Another alternative would be the support of doxygen. It does not seem to happen quite soon from other issues I could see. Having equation processed when browsing code would certainly please scientists. Hopefully hearing about such possibility soon :)

@vscodebot vscodebot bot locked and limited conversation to collaborators Nov 17, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
feature-request Request for new features or functionality markdown Markdown support issues under-discussion Issue is under discussion for relevance, priority, approach
Projects
None yet
Development

No branches or pull requests

2 participants