leanprover / leanprover/vscode-lean4
Preview Markdown images in docstrings
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 313
- Forks
- 104
- Avg merge
- 1h 56m
- Merged PRs (30d)
- 1
Description
Images inserted with Markdown syntax into docstrings do not render in the on hover pop-up. Such a preview would be great, especially for geometric definitions and theorems.
In fact, it seems that any Markdown links to local files (binary or not) cannot be opened by clicking on the tooltip link (I assume this is not a VSCode issue, as it is working fine for .md files).
Related:
https://github.com/leanprover/vscode-lean4/issues/212
https://github.com/leanprover/vscode-lean4/issues/196
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start by reviewing related issues #212 and #196, then trace how Markdown in docstrings is rendered in the on-hover pop-up. Confirm the behavior for embedded images and links to local binary or text files; done means those resources can be previewed or opened from the tooltip as described.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript, vscode
- Domain
- devtools, frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100