Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Josee9988/Changelog-and-Markdown-snippets
๐ Snippets for the creation of ๐ฐ๐ต๐ฎ๐ป๐ด๐ฒ๐น๐ผ๐ด๐ ๐ถ๐ป ๐ฉ๐ฆ๐๐ผ๐ฑ๐ฒ! Create useful version documentation๐ Maintain a ๐ฐ๐ต๐ฎ๐ป๐ด๐ฒ๐น๐ผ๐ด following the "use a changelog" guide ๐
https://github.com/Josee9988/Changelog-and-Markdown-snippets
changelog changelog-activity changelog-dialog changelog-formatter changelog-generator changelog-schema changelogger changelogs changes markdown-snippet markdown-snippets snippets vscode vscode-extension vscode-extensions vscode-plugin vscode-plugins vscode-snippet vscode-snippets vscode-snippets-extensions
Last synced: 2 months ago
JSON representation
๐ Snippets for the creation of ๐ฐ๐ต๐ฎ๐ป๐ด๐ฒ๐น๐ผ๐ด๐ ๐ถ๐ป ๐ฉ๐ฆ๐๐ผ๐ฑ๐ฒ! Create useful version documentation๐ Maintain a ๐ฐ๐ต๐ฎ๐ป๐ด๐ฒ๐น๐ผ๐ด following the "use a changelog" guide ๐
- Host: GitHub
- URL: https://github.com/Josee9988/Changelog-and-Markdown-snippets
- Owner: Josee9988
- License: mit
- Created: 2019-08-02T18:24:32.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-11-23T10:50:09.000Z (about 3 years ago)
- Last Synced: 2024-11-23T20:31:53.496Z (3 months ago)
- Topics: changelog, changelog-activity, changelog-dialog, changelog-formatter, changelog-generator, changelog-schema, changelogger, changelogs, changes, markdown-snippet, markdown-snippets, snippets, vscode, vscode-extension, vscode-extensions, vscode-plugin, vscode-plugins, vscode-snippet, vscode-snippets, vscode-snippets-extensions
- Homepage: https://marketplace.visualstudio.com/items?itemName=josee9988.changelog-and-markdown-snippets
- Size: 212 KB
- Stars: 16
- Watchers: 1
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
- jimsghstars - Josee9988/Changelog-and-Markdown-snippets - ๐ Snippets for the creation of ๐ฐ๐ต๐ฎ๐ป๐ด๐ฒ๐น๐ผ๐ด๐ ๐ถ๐ป ๐ฉ๐ฆ๐๐ผ๐ฑ๐ฒ! Create useful version documentation๐ Maintain a ๐ฐ๐ต๐ฎ๐ป๐ด๐ฒ๐น๐ผ๐ด following the "use a changelog" guide ๐ (Others)
README
# **Changelog and Markdown snippets for VSCode**
Build **smoothly** your **Changelog** and **Markdown** using the best snippets!
Following **[keep a changelog](https://keepachangelog.com/en/1.0.0/) format** and **[MarkdownLint](https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md) rules**.
For more information check our: **[GitHub repository](hhttps://github.com/Josee9988/Changelog-and-Markdown-snippets)** and **[VisualStudio Marketplace](https://marketplace.visualstudio.com/items?itemName=josee9988.changelog-and-markdown-snippets)** or **[OpenVSX registry](https://open-vsx.org/extension/Josee9988/changelog-and-markdown-snippets)**.
Do you want to help us improve the extension or did you found a bug?
**[Let us know](https://github.com/Josee9988/Changelog-and-Markdown-snippets/issues)** or contact **[me]([email protected])**.
Check our **[changelog](CHANGELOG.md)**.
> **24** Snippets that will make *your coding experience much **faster***.
---
[](https://marketplace.visualstudio.com/items?itemName=josee9988.changelog-and-markdown-snippets)
[](https://marketplace.visualstudio.com/items?itemName=josee9988.changelog-and-markdown-snippets)
[](https://marketplace.visualstudio.com/items?itemName=josee9988.changelog-and-markdown-snippets)
---
## **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!
```json
"editor.snippetSuggestions": "top",
```
- Snippets autocompletion when pressing tab.
```json
"editor.tabCompletion": "on",
```
- Snippets will auto appear when writing.
```json
"editor.quickSuggestions": true,
```
---
## **Built with** ๐ ๏ธ๐ง
- [Virtual Studio Code](https://code.visualstudio.com/)
- [Yo code](https://code.visualstudio.com/api/get-started/your-first-extension)
- [vsce](https://code.visualstudio.com/api/working-with-extensions/publishing-extension)
---
### Did you enjoy the extension? Help us raise these numbers ๐ฅฐ ๐
[](#languages-primarily-tested)
[](#languages-primarily-tested)
[](#languages-primarily-tested)
[](#languages-primarily-tested)
[Check my VSCode theme](https://marketplace.visualstudio.com/items?itemName=josee9988.black-garnet-theme) ๐งฒ
[Check my VSCode minifier](https://marketplace.visualstudio.com/items?itemName=josee9988.minifyall) ๐ฅ
---
*Made with a lot of โค๏ธโค๏ธ by **[@Josee9988](https://github.com/Josee9988)***