Rust-analyzer: Live rendered view of document with markdown

Created on 6 Mar 2020  路  2Comments  路  Source: rust-analyzer/rust-analyzer

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.

A-vscode S-actionable

Most helpful comment

I have even one more feature that I really miss from TypeScript. This is highlighting markdown syntax in doc comments:
image

Anyway, rendering live markdown preview is kinda doable, this just needs vscode API investigation.

All 2 comments

I have even one more feature that I really miss from TypeScript. This is highlighting markdown syntax in doc comments:
image

Anyway, rendering live markdown preview is kinda doable, this just needs vscode API investigation.

What about full language support in markdown code blocks? Is there an issue for that? Granted, it may not necessarily be a rust-specific solution. See this intention:
https://github.com/pushqrdx/code-fences#planned

Was this page helpful?
0 / 5 - 0 ratings

Related issues

dakyskye picture dakyskye  路  23Comments

ninjasource picture ninjasource  路  33Comments

aloucks picture aloucks  路  32Comments

yaahc picture yaahc  路  27Comments

bryanburgers picture bryanburgers  路  31Comments