This snippet generates boilerplate code for creating a simple README document using Markdown.
This snippet's dependencies are an up-to-date version of the VSCode IDE:
- Install VSCode: https://code.visualstudio.com
Using the snippet requires copying the contents of the snippet.json file and pasting them into either the markdown.json snippet configuration file, or the global snippets configuration file in VSCode. The user snippets configuration files are accessible via VScode Preferences under the Configure User Snippets option.
You can now test the snippet by creating any file in VSCode with the .md extension, typing the readme prefix trigger, and hitting <TAB> to insert your snippet's code at the current position of the cursor. Once the snippet has populated code into your file it will immediately reposition your cursor at the snippet's first placeholder position. Advance through each placeholder by entering content and/or hitting the <TAB> key.
- User Defined Snippets in VSCode: https://code.visualstudio.com/docs/editor/userdefinedsnippets
- VSCode Snippet Placeholders: https://code.visualstudio.com/docs/editor/userdefinedsnippets#_placeholders