Sometimes documentation of our projects can be a challenge. Even if some high-level business details can be documented outside on a Confluence page or similar, I like having the technical documentation with the code. It allows the next developer to know the details of the solution and quickly understand the steps to start with it. And also, a quicker, clean and versioned way of documenting the code.
Currently, my favourite IDE is Visual Studio. In my personal case, I use Visual Studio Professional. And at the beginning I struggled to edit README.md files since I was not able to see the final result of what I was doing. But here’s an extension to help you out! It’s Markdown Editor v2.
How to install it?
The installation is really quickly:
- Open Visual Studio
- Go to Extensions > Manage Extensions
- Search for “Markdown Editor v2” and click the “Install” button
- You should see something like
- Now just close Visual Studio and click “Modify” in the window that will appear
- Few seconds later, the extension will be done, and you can reopen Visual Studio
Start editing your README.md files
Now, you already have the extension installed and you can open whichever .md file you want. Just a small note: if you already had a .md file opened before the installation, an error message might appear on your screen. Don’t worry, just close the file and reopen it again.
And “voilà” here we have our README.md file result directly on our Visual Studio:
Hope it was helpful as it’s for me and see you in the next one!