Ecosystems:
VS Code Extension
vscode-readme
This was inspired by @katherinepeterson who made the wonderful 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
Package Rankings
Top 9.51% on Proxy.golang.org