rust-lang / rust-lang/rust-analyzer
Live rendered view of document with markdown
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 16.9k
- Forks
- 2.2k
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 72
Description
While working on documenting APIs of a rust crate, I found that it would be nice to have a live rendered view of current editing function / struct documentation in a separate window in my editor.
I think it is not so hard to implement, it would be similar to how we implement Show Syntax Tree and could be possible to reuse some hover code for that.
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.
Research direction
Start by inspecting the existing Show Syntax Tree implementation and the hover code mentioned in the issue. Determine how a live rendered view of the current function or struct documentation could appear in a separate editor window; done means the current Markdown documentation renders and updates while editing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, rust
- Domain
- developer-experience, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100