This README file was written using this project - try it at editread.me 😎
A very basic live editor for README files written in react. It uses Showdown for the HTML and markdown conversions. I'm also using the styling of the GitHub README's, to hopefully make it as close of an experience as possible for the writer.
This app has been deployed using GitHub Pages.
The live demo can be accessed here: Live Editor - DEMO
To install the Live Editor, follow these steps:
Linux and macOs:
git clone https://github.com/isoyute/edit-readme
cd edit-readme/client
npm i
I've only installed, ran and tested this app on Ubuntu 18.04.5 LTS using latest Chrome.
This is a list of things that I still plan on working on when I get the chance:
- Add spell check
- Add templates
- Add ability to import a README (.md or maybe straight from GitHub?)
- Add ability to save
- Add a markdown cheatsheet
- Add buttons for markdown (kind of like the Word text formatting at the top)
This project uses the following license: MIT