Skip to content

Latest commit

 

History

History
112 lines (76 loc) · 3.46 KB

README.md

File metadata and controls

112 lines (76 loc) · 3.46 KB
Raw

✍🏻 markItDown

React Webapp to edit and preview markdown


GitHub issues   GitHub license   GitHub stars   GitHub stars   GitHub forks
Netlify Build

⭐ Features

  • Live Preview
  • Copy to clipboard
  • Save as HTML
  • Multiple theme support
  • Works offline (PWA)
  • One-tap clear button
  • Adjustable window size

⚙ Setup locally

Requirements 🍫

  • Node.js
  • npm
  • Git (optional)

Common setup ⚒

Clone the repo and install the dependencies.


git clone https://github.com/aromalanil/markItDown.git
cd Markdown-Editor
npm install

Run in development mode 🧪

Execute the following command to run the app in the development mode.

npm start

Open http://localhost:3000 to view it in the browser. The page will reload if you make edits. You will also see any lint errors in the console.


Generate a Build 📦

npm run build

Builds the app for production to the build folder.

It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

Now the app is ready to be deployed!


📜 License

MIT License

Copyright (c) 2020 Aromal Anil

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

✍🏻 Author

Aromal Anil