https://github.com/sumitnalavade/vs-code-readme-editor

Create, Customize and Commit your project's ReadMe with an easy to use VS Code extension
https://github.com/sumitnalavade/vs-code-readme-editor

markdown-editor react readme readme-generator vscode vscode-extension

Last synced: 6 months ago
JSON representation

Create, Customize and Commit your project's ReadMe with an easy to use VS Code extension

• Host: GitHub
• URL: https://github.com/sumitnalavade/vs-code-readme-editor
• Owner: SumitNalavade
• Created: 2022-08-01T07:55:41.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-06-15T08:52:40.000Z (over 2 years ago)
• Last Synced: 2025-04-13T22:16:00.194Z (9 months ago)
• Topics: markdown-editor, react, readme, readme-generator, vscode, vscode-extension
• Language: TypeScript
• Homepage:
• Size: 17.1 MB
• Stars: 23
• Watchers: 1
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# VS Code Readme Editor 📝  

A VS Code extension to create, customize and save your Readme without having to leave your project workspace.

Built with TypeScript & React using the VS Code Webview API

Over 10k Downloads! (May 2023)  



# VS Code Extension Marketplace

https://marketplace.visualstudio.com/items?itemName=SumitNalavade.vscode-readme-editor

## Installation  

In the VS Code extension marketplace look up:

~~~javascript  

  SumitNalavade.vscode-readme-editor

~~~  

## Features ✨

- Accessibility in VS Code  

- Choose from components to speed up your workflow. 

- Download directly to project root  

- Import existing Readme and customize

- Live Previews

- Dark/Light Mode based on VS Code theme

## Demo 🚀

![App Screenshot](https://github.com/SumitNalavade/VS-Code-ReadMe-Editor/blob/main/assets/demo/demo_1.gif?raw=true)  

![App Screenshot](https://github.com/SumitNalavade/VS-Code-ReadMe-Editor/blob/main/assets/demo/demo_2.gif?raw=true)  

## Contributing 🧑‍💻  

Contributions are always welcome!  

- Open an issue

- I'll review the issue and assign you

- Open a pull request!

## Run Locally 🏠  

Clone the project  

~~~bash  

  git clone https://github.com/SumitNalavade/VS-Code-ReadMe-Editor

~~~

Go to the project directory  

~~~bash  

  cd vscode-readme-editor

~~~

Install dependencies  

~~~bash  

npm install

~~~

Start the extension  

- Press 'F5' on your machine to open the VS Code extension development preview.

 

## License 💼 

[MIT](https://choosealicense.com/licenses/mit/)  

 

## Acknowledgements ❤️ 

- [Readme.so](https://github.com/octokatherine/readme.so)

- [Awesome README](https://github.com/matiassingers/awesome-readme)

- [How to write a Good readme](https://bulldogjob.com/news/449-how-to-write-a-good-readme-for-your-github-project)  

 

## Contributors 💙 

- [Sumit Nalavade](https://github.com/SumitNalavade)

-  [Unjin Jang](https://github.com/unwls)

-  [hacker0limbo](https://github.com/hacker0limbo)

## Feedback 📣 

If you have any feedback, please reach to me at vs.nalavade2003@gmail.com.