/Changelog-and-Markdown-snippets

๐ŸŒž Snippets for the creation of ๐—ฐ๐—ต๐—ฎ๐—ป๐—ด๐—ฒ๐—น๐—ผ๐—ด๐˜€ ๐—ถ๐—ป ๐—ฉ๐—ฆ๐—–๐—ผ๐—ฑ๐—ฒ! Create useful version documentation๐Ÿ“‘ Maintain a ๐—ฐ๐—ต๐—ฎ๐—ป๐—ด๐—ฒ๐—น๐—ผ๐—ด following the "use a changelog" guide ๐Ÿ“œ

MIT LicenseMIT

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.


Version Downloads Rating


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? ๐Ÿ“ธ ๐Ÿ˜

GIF


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 ๐Ÿฅฐ ๐ŸŽ‰

GitHub followers GitHub stars GitHub watchers GitHub forks

Check my VSCode theme ๐Ÿงฒ

Check my VSCode minifier ๐Ÿ”ฅ


Made with a lot of โค๏ธโค๏ธ by @Josee9988