Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maurodesouza/vscode-simple-readme
📝 Readme Generator for Visual Studio Code ❤️
https://github.com/maurodesouza/vscode-simple-readme
generator readme readme-bolierplate readme-generator readme-template template vscode-extension
Last synced: 15 days ago
JSON representation
📝 Readme Generator for Visual Studio Code ❤️
- Host: GitHub
- URL: https://github.com/maurodesouza/vscode-simple-readme
- Owner: maurodesouza
- License: mit
- Created: 2020-08-18T21:31:22.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-10T12:33:05.000Z (over 1 year ago)
- Last Synced: 2024-04-09T15:05:54.951Z (3 months ago)
- Topics: generator, readme, readme-bolierplate, readme-generator, readme-template, template, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=maurodesouza.vscode-simple-readme
- Size: 13.7 MB
- Stars: 121
- Watchers: 4
- Forks: 36
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Lists
- my-awesome-stars - maurodesouza/vscode-simple-readme - 📝 Readme Generator for Visual Studio Code ❤️ (TypeScript)
README
Simple Readme
Generate readme fastly and simply with Simple Readme
![]()
## Features
- Includes one template based on this [article](https://blog.rocketseat.com.br/como-fazer-um-bom-readme);
- Support En and pt-BR languages;
- Generates title and badges by reading the name of the project on the package.json or the root folder;
- Generates a link to your Github profile;## Settings
You can add these settings in your settings.json
```js
"simple.readme.settings.github": "YOUR GITHUB USERNAME""simple.readme.settings.name": "YOUR GITHUB NAME"
"simple.readme.settings.lang": "THE TEMPLATE LANGUAGE" // Default en
```
* `simple.readme.settings.github`: To add links for you Github profile and to get your repository badges;
* `simple.readme.settings.name`: To put your name on the file end;
* `simple.readme.settings.lang`: The template language;## Template
- App gif/image;
- Title;
- Badges;
- Status;
- Menu content;- sections
- About your project;
- Features;
- Technologies;
- Requirements;
- Starting;
- License;To see the markdown template, [click here](./templates/en/default.md)
To see how the resulting final looks like, [click here](https://github.com/maurodesouza/weather-react-app);