Changelog-and-Markdown-snippets
๐ Snippets for the creation of ๐ฐ๐ต๐ฎ๐ป๐ด๐ฒ๐น๐ผ๐ด๐ ๐ถ๐ป ๐ฉ๐ฆ๐๐ผ๐ฑ๐ฒ! Create useful version documentation๐ Maintain a ๐ฐ๐ต๐ฎ๐ป๐ด๐ฒ๐น๐ผ๐ด following the "use a changelog" guide ๐
MIT License
Changelog and Markdown snippets for VSCode
Build smoothly your Changelog and Markdown using the best snippets!
Following keep a changelog format and MarkdownLint rules.
For more information check our: GitHub repository and VisualStudio Marketplace or OpenVSX registry.
Do you want to help us improve the extension or did you found a bug? Let us know or contact me.
Check our changelog.
24 Snippets that will make your coding experience much faster.
Installation ๐ฉโ
- Open the Command Palette of VSCode with Ctrl+P or โP
- And type:โก๏ธ
ext install josee9988.changelog-and-markdown-snippets
Snippets cheat sheet ๐๐
| SNIPPET | DESCRIPTION |
|---|---|
cl-Init |
The initial structure of the changelog |
cl-NewVersion |
Set a new version with the version name and the current date. |
cl-Yanked |
For versions that had to be pulled because of a serious bug or security issue. |
cl-Unreleased |
For the actual changes. |
cl-Added |
Add new features to your project. |
cl-Changed |
For changes in existing functionality. |
cl-Deprecated |
For soon-to-be removed features. |
cl-Removed |
For removed features. |
cl-Fixed |
For bug fixes. |
cl-Improved |
For feature improvements. |
cl-Security |
For security fixes and vulnerabilities. |
cl-Published |
Adds a published tag. |
md-Link |
Link to a file or to a web page. |
md-Italic |
Adds an Italic text. |
md-Bold |
Adds a bold text. |
md-Strike |
Strike through your text. |
md-List |
Make a quick 3 elements list. |
md-InlineCode |
Insert an inline code. |
md-MultiLineCode |
Insert multi line code. |
md-h1 |
Insert a header one H1. |
md-h2 |
Insert a header two H2. |
md-h3 |
Insert a header three H3. |
md-h4 |
Insert a header four H4. |
md-h5 |
Insert a header five H5. |
md-h6 |
Insert a header six H6. |
md-Box |
Insert an unchecked checkbox. |
Prefixes ๐ฑ๐ฒ
cl-comes from Changelog specific snippets.
md-comes from Markdown general-purpose snippets.
How does it look when writing a real changelog? ๐ธ ๐
Our recommendations ๐ฏ๐
- Set the IntelliSense snippets to appear on top for the smoothest experience!
"editor.snippetSuggestions": "top",
- Snippets autocompletion when pressing tab.
"editor.tabCompletion": "on",
- Snippets will auto appear when writing.
"editor.quickSuggestions": true,
Built with ๐ ๏ธ๐ง
Did you enjoy the extension? Help us raise these numbers ๐ฅฐ ๐
Made with a lot of โค๏ธโค๏ธ by @Josee9988
