📙 Markdown Wiki

Keep a wiki in Visual Studio Code.

Installation

You can get this extension in two ways:

• By going directly to the Visual Studio marketplace ^1.
• By searching markdown-wiki in the Extensions Tab of Visual Studio Code.

We recommend these extensions for a better editing experience:

• Markdown All in One for Markdown keyboard shortcuts and a better Markdown preview.
• LTeX – LanguageTool grammar/spell checking for checking grammar and spelling.
• Markdown Footnote for previewing footnotes.

We recommend these programs for enhanced functionality.

• Git for tracking changes to your files.
• Pandoc for automatically ordering footnotes and endnotes.

Usage

This extension is essentially a "read only" analysis tool. It has three clusters of functionality.

• Readability
• Footnotes
• Wiki Links

Each of these clusters "just work". They will apply automatically on any text change or save to any Markdown file in any VS Code workspace. You do not need to add any configuration. And none of these clusters will make any changes to your files.

Keyboard Shortcuts

This extension only adds two shortcuts. Both are for managing footnotes. Other shortcuts are added by Markdown All in One (if installed), covered here.

• Ctrl/Cmd+ '. Insert a url on your clipboard as a Markdown footnote. Your footnotes and endnotes will be ordered automatically after insertion.
• Ctrl/Cmd+ shift + '. Automatically order footnotes and endnotes. Pandoc must be installed on your system for this command to work.

Readability

This extension uses the automated readability index (ARI) to check readability ^2. It will automatically apply this check on every text change. If a sentence is greater than 11 words, we flag it with:

• Warning (Blue): "Hard to read" if the ARI >= 10 and ARI < 14
• Error (Red): "Very hard to read" if the ARI >= 14
• Error (Red): If the sentence is longer than 25 words

Note: The average reader only understands text at an 8th grade level. This is ARI < 10 ^3. The average reader also finds a sentence with more than 25 words very hard to read ^4.

Note: In the VS Code Command Palette, you can use Analyze Files. This will apply ARI to every Markdown file in your workspace. This command will also check two, other things. One, missing wiki links. Two, missing or unmatched footnotes and endnotes.

Footnotes

Managing Markdown footnotes is a pain. This extension makes it a bit easier.

• Automatically check missing or unmatched footnotes in a file on every save.
• Automatically order footnotes and endnotes via Ctrl/Cmd+ shift + '. Pandoc must be installed on your system for this command to work.
• Insert a url on your clipboard as a Markdown footnote via Ctrl/Cmd+ '. Your footnotes and endnotes will be ordered automatically after insertion.

Wiki Links

Wiki links represent an internal link to another file. They have become widely adopted because they are short and easy to read. Here's how we use them:

• You have the wiki link [[security]] in a file called cool.md.
• If that link matches the name of another file, security.md, we will recognize it as a link.
• The extension will also handle variation in capitalization and pluralization.
• So you can write [[Security]] or [[securities]] in cool.md without error!