I have a confession. I love Markdown. There I said it, my confession is out in the open for all to see.
Seriously though, I do find this documentation language very useful, and easy to use. With just a few commands I can produce a nicely formatted document that can be displayed in my code editor, as well as on platforms like GitHub. I’ve even begun authoring these blog posts in Markdown.
A big reason for me is the ability to integrate it into my projects. VSCode, as well as the full blow Visual Studio, support Markdown (with of course the proper extensions installed). When I create a new PowerShell project in VSCode, I can store the projects documentation in Markdown format right alongside the PowerShell code.
Speaking of VSCode…
A great thing about VSCode is the ability to create your own code snippets. A snippet is a text replacement system where I can enter a few characters of text and VSCode will then replace it with the full snippet. Snippets are activated using the Intellisense feature of VSCode.
One example, I have a standard header I put at the top of my PowerShell scripts. When I defined this header as a snippet, I named it
psheader. Now I can enter
pshead into my PowerShell script. VSCode’s intellisense feature will prompt me with the list of snippets I have that being with
pshead. I can then pick the one I want (
psheader), press enter and the snippet of
psheader will be replaced with the full text of my file header.
By default, pretty much every language in VSCode has the ability to handle snippets.
Markdown Snippets in VSCode
Shocking right? How could such an awesome language like Markdown not have snippets? (And yes, Markdown may not be a language in the strictest sense, but it’s a close enough word for now.)
Well it’s possible to enable Markdown snippets in PowerShell. Sometime back I created a GitHub project that shows you how to enable and use snippets for Markdown. In addition, I included my snippets for both PowerShell and Markdown.
Rather than reiterating everything here, I’ll just point you to that repository.
The main file in the repository,
ReadMe.md gives a brief overview and explanation on how to use snippets.
Enable_Intellisense_in_Markdown.md does just what is says, shows you how to enable intellisense for Markdown in VSCode.
In VSCode, you can use certain replacements in your snippets. For example, you can embed the
$CURRENT_YEAR snippet variable in your snippet (no matter what language) and when the snippet is generated into your code, it will replace the
$CURRENT_YEAR with the actual current year.
I included a file,
Snippet_Reference.md that lists the various snippet variables and gives a bit more explanation on how to use them.
If you aren’t familiar with Markdown, or don’t use it very often, you’ll find the file
Markdown_Cheatsheet.md useful. It has a list of the most often used Markdown formatting commands.
Finally I included two
.json files. These are the snippets I use for PowerShell and Markdown on my system. You can use these as a guide in creating your own snippets, or copy the ones you find useful onto your VSCode installation.
If you use the VSCode sync settings feature, they you will be happy to know snippets are included as part of the sync process. You can modify your snippet files on one computer and they will be copied to all the other computers you sync VSCode on.
This was a brief post that primarily served to bring awareness to snippets, as well as the ability to use them with Markdown files. Go take a look at the repository and with just a little effort I believe you’ll find yourself becoming much more productive with the addition of snippets to your toolbox.