Create, Customize and Commit your project's ReadMe in VS Code with an integrated extension

Sumit Nalavade

Last update: Dec 29, 2022

Overview

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

Installation

In the VS Code extension marketplace look up:

  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

Demo 🚀

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

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

Go to the project directory

  cd vscode-readme-editor

Install dependencies

npm install

Start the extension

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

License 💼

MIT

Acknowledgements ❤️

Contributors 💙

Feedback 📣

If you have any feedback, please reach to me at [email protected].

Testing how many commit can be committed to GitHub. So far 12,225,265 commits

GitHub's Commit Capacity. Motivation Checking some relations and capabilities between client-server model, GitHub & Git. Goal Making this repo most co

Mar 25, 2022

The entire bee movie script, but in commit messages.

Project Name Project Description Live Version This page is not yet deployed. Feedback and Bugs If you have feedback or a bug report, please feel free

Oct 1, 2022

This is email scheduler made using MERN. This repo contains server code, client repo is linked in readme.

Email Scheduler Client This is an email scheduler server (client in different repository). It is made using node.js/express.js. Overview User can sign

Dec 3, 2022

Showcase your skills on your Github readme or resumé with ease ✨

Showcase your skills on your GitHub or resumé with ease! Powered by Cloudflare Workers ⚡ Docs Example Specifying Icons Themed Icons Icons Per Line Cen

Dec 31, 2022

Possibly the coolest way to install apps and customize your Mac!

BrewMyMac Possibly the coolest way to install apps and customize your Mac! Introduction This article explains the motivation behind this project. Gett

Dec 6, 2022

A plugin that uses multiple block, Tailwind and is fully integrated into the standard build process

Tailwind CSS Custom Block Plugin This repo leverages the @wordpress/scripts package and it's ability to use PostCSS to introduce TailwindCSS to the bu

Dec 31, 2022

⚡⚙️ Fast prototyping with template engines and integrated frontend tools. Vituum is a small wrapper around Vite.

⚡ ⚙️ Vituum Still in early development. Fast prototyping with template engines and integrated frontend tools ⚡ Vite integrated 🚀️ Fast prototyping 🛠

Jan 3, 2023

A simple yet feature-rich counter that allows you to count the views of your Github README files and profile page

View Counter Purpose This is a simple yet feature-rich counter that allows you to count the views of your github README files and profile page. Featur

Nov 10, 2022

Welcome contributers❤️🎉. Just add your name, Github profile link and Linkedin link🔗 Look at Readme for more.📖

Hello Welcome Developers! Step - 1 Create a GitHub account, if you don't already have one. Step - 2 Register for Hacktoberfest: Navigate to the Hackto

Oct 31, 2022

Comments

Would like to contribute to this awesome project ☺️
Thank you very much for this nice extension!

Your styles are already really nice but my suggestions are below

Change mouse cursor to a pointer when the user hovers the clear button

Disable certain texts from being hovered

Change mouse cursor to a pointer when pressing the initial reload editor button

Just want to make this project better and prettier 😊
opened by unwls 8
Not able to install ReadMe editor

I am getting following error while trying to install the extension on Mac version of VS code

Unable to install 'sumitnalavade.vscode-readme-editor' extension because it is not compatible with the current version of VS Code (version 1.42.1).

Do we have any fix for this?

opened by devauk 4
[2022/08/20] - Style and Code style edit
Summary

Added extra style to texts

Added missing nonce to script tags

Added missing semi colons

Created useHover custom hook

Note

Some components were using single quote and some were using double, so i made them all use double if that's okay with you?

Also maybe a prettier configuration file would be nice for future contributors! Would keep consistency in code style for this project.

No breaking changes, tested in development mode and works perfectly fine!

Preview of Change
opened by unwls 1
Feature Request: Add recently edited files to sidebar panel

A great feature for anyone looking to contribute would be to add a section in the sidebar panel for recently edited Readmes. A good spot would be right under the 'Reload Editor' button

Something similar to this:

enhancement help wanted good first issue

opened by SumitNalavade 5

Create, Customize and Commit your project's ReadMe in VS Code with an integrated extension

Related tags

Overview

VS Code Readme Editor 📝

Installation

Features ✨

Demo 🚀

Contributing 🧑‍💻

Run Locally 🏠

License 💼

Acknowledgements ❤️

Contributors 💙

Feedback 📣

You might also like...

Comments

Summary

Note

Preview of Change

Owner

Sumit Nalavade

🎨 Beautify your github profile with this amazing tool, creating the readme your way in a simple and fast way 🚀 The best profile readme generator you will find ⚡

A simple editor allows you to easily add and customize all the sections you need for your profile's readme.

⚙ With a little preparation, the typescript eslint generic rules for vodyani may be readily integrated into projects.

Follow along with blog posts, code samples, and practical exercises to learn how to build serverless applications from your local Integrated development environment (IDE).

Create beautiful and simple HTML pages from your Readme.md files

A Hackable Markdown Note Application for Programmers. Version control, AI completion, mind map, documents encryption, code snippet running, integrated terminal, chart embedding, HTML applets, plug-in, and macro replacement.

自动保持 GitHub 提交状态常绿 a commit every day, keep your girlfriend far away.

A Meme generator website where you can change and customize images to create great memes😎.

A VS Code extension to practice and improve your typing speed right inside your code editor. Practice with simple words or code snippets.

Visualize the Directed Acyclic Graph that Git creates to connect Commit, Tree and Blob objects internally.