EddyLuten / mkdocs-alias-plugin

An MkDocs plugin allowing links to your pages using a custom alias
MIT License
12 stars 2 forks source link

Aliases VS Code Extension Wishlist #2

Open EddyLuten opened 2 years ago

EddyLuten commented 2 years ago

It would be nice to have a tie-in VS Code extension that added first-class support for aliases in Markdown files. I'm capturing some of the requirements here before starting development on it.

Proper Rendering

Aliases are rendered strangely within VS Code:

Screen Shot 2022-07-07 at 11 11 07 AM

Rendering these aliases closer to links would be preferable:

Screen Shot 2022-07-07 at 11 13 52 AM

Also perhaps displaying red squigglies if the alias wasn't found within the scope of the project.

Auto-Completion

While typing the [[ alias syntax, it would be nice to have an auto-complete dialog show with known aliases and their associated page titles.

Screen Shot 2022-07-07 at 11 16 43 AM

Defining Aliases

It would be nice to have a way to easily define an alias for any active Markdown file, including inserting a meta-section into the file if none exists.