📙 Markdown Wiki
Create and manage a Markdown wiki using Visual Studio Code.
You can get the extension by:
Features
Manage [[wiki]] links
Many tools, like Roam, Bear, and Obsidian use wiki links. That is because they are short and readable. Hence, we use them too!
For example, you have a wiki link, [[dragon]]. If the link matches the name of a file in your workspace, the extension will recognize it as a link. If it does not, the extension will flag it as a broken link.
For example, [[dragon]] will link to a file called dragon.md, no matter where the file is. The extension can also handle variation in capitalization and pluralization. So you can write [[Dragon]] or [[dragons]] without error.
Analyze your writing
Check readability
If a sentence is greater than 11 words, flag it with:
- Warning: "Hard to read" if the
ARI score >= 10 and < 14.
- Error: "Very hard to read" if the
ARI score >= 14.
- Error: If the sentence is longer than 25 words.
ARI stands for automated readability index.
Here's how we chose these benchmarks:
Readable.com found the average reader can only comprehend text at an 8th grade level. This is an ARI score of < 10.
Gov.UK found any sentence with eleven words or fewer is easy to read. By contrast, any sentence with more than 25 words is very hard to read.
Prose
We can analyze the prose of each file using the following libraries:
Note: Joblint and Write Good are disabled by default. You can enable both in the VS Code settings.
Caution: You must have proselint installed on your system for this to work. This extension will not install proselint for you!
By default, your prose is automatically analyzed:
- On every open file
- Each time the text changes
If you'd like to analyze every file in your workspace, you can do that! Just use the Analyze Files command. It is ctrl+shift+/ or cmd+shift+/, depending on Mac or PC.
Note: Proselint is quite slow, so it is not executed on the Analyze Files command.
Managing Markdown footnotes is a pain. Use these commands to automate that task away!
Caution: These commands, while convenient, make changes to your files.
Insert Footnote. Insert a url on your clipboard as a Markdown footnote.
Keyboard shortcut: crtl + ' or cmd + '.
Reorder Footnotes in File. Reorder all the footnotes in a Markdown file.
Keyboard shortcut: ctrl+shift+' or cmd+shift+'.
Reorder Footnotes in Workspace. Reorder all the footnotes in all your Markdown files.
Keyboard shortcut: ctrl+alt+' or cmd+alt+'.
