Guides for SE student projects »
Caution: VS Code guides section is a work-in-progress, containing content contributed by students.
- If you notice any bugs or suggestions for improvements, please report at https://github.com/se-edu/guides/issues
- You are welcome to contribute by sending a PRs to https://github.com/se-edu/guides/pulls too.
VS Code - Useful Plugins
Markdown All in One
Markdown All in One plugin can be used to preview .md files in real-time while editing them in VS Code. This is useful for editing README files, documentation, and tutorial content.
The plugin helps mainly by,
- stylising the Markdown text in-place (e.g., bold text is shown as bold) so that you get some sense of the formatting you are using, as is shown on the left side of the screenshot above.
- showing a preview of how the page will be rendered in HTML, as shown on the right side of the screenshot above.
Installing the plugin
- Open the Extensions sidebar in VS Code.
- Search for ‘Markdown All in One’ by Yu Zhang.
- Click
Install.
You should now see a new preview option when working with Markdown files.
Previewing Markdown
To preview the Markdown side-by-side with your .md file:
- Open a
.mdfile (e.g. README.md) - To see the rendered Markdown in a split view beside your code, select the Preview icon in the editor bar (see screenshot in the previous section)
Additional Features
- Useful shortcuts including autocomplete, keyboard shortcuts, pasting links.
- Supports LaTeX equations, diagrams, footnotes and math blocks.
- Toggle code blocks, section numbers, table of contents, lists.
- Can print documents to HTML.
- GitHub Flavoured Markdown is supported.
For more information, view the Markdown All in One documentation here.
Contributors: Sulaksha Muthukrishnan (@crmlatte)