https://github.com/threecommaio/vscode-readme
README snippets for Visual Code inspired by readme.so
https://github.com/threecommaio/vscode-readme
snippets vscode vscode-extension
Last synced: 11 months ago
JSON representation
README snippets for Visual Code inspired by readme.so
- Host: GitHub
- URL: https://github.com/threecommaio/vscode-readme
- Owner: threecommaio
- Created: 2021-05-01T23:18:02.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2022-02-07T04:16:23.000Z (over 4 years ago)
- Last Synced: 2025-06-03T11:53:26.541Z (about 1 year ago)
- Topics: snippets, vscode, vscode-extension
- Language: Go
- Size: 12.7 KB
- Stars: 15
- Watchers: 0
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# vscode-readme
This was inspired by [@katherinepeterson](https://www.github.com/katherinepeterson) who made the wonderful [readme.so](https://readme.so/)! Huge thanks.
## Configuration
Make sure you have quickSuggestions enabled in your `settings.json`. By default VSCode turns this off for Markdown.
```
{
"[markdown]": {
"editor.quickSuggestions": true
}
},
```
## Usage
If you want all the sections below you can use the snippet:
```
readme
```
If you want to build up your README by section it's broken down into the following snippets:
* Title
* Acknowledgements
* API Reference
* Appendix
* Authors
* Badges
* Contributing
* Demo
* Used By
* Usage/Examples
* Running Tests
* Tech Stack
* Support
* Screenshots
* Run Local
* Roadmap
* Related
* Optimizations
* Logo
* License
* Lessons
* Installation
* Feedback
* Features
* FAQ
* Environment Variables
* Documentation
* Deployment