Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 2.14 KB

README.md

File metadata and controls

83 lines (56 loc) · 2.14 KB

MarkdUp

MarkdUp is an online Markdown editor powered by React + Redux.

Build Status JavaScript Style Guide Packagist

Features

  • Dual HTML + Markdown editors
  • Sytax highlighting, error checking
  • Mobile friendly

Getting Started

Type some Markdown on the left and see your preview on the right. Want to work in HTML instead? Click the code icon in the editor header.

Settings

Click the gear icon in the header to adjust the options below.

Setting Description
Auto Save Save session in browser on update
Live Complete Show HTML syntax popup on typing
Split View Display dual editors (HTML + Markdown)
Sync Editors Update contents of editors to match
Reset Session Remove all data from browser

Local Development

To work locally and extend Markdup follow these steps.

  1. Clone the repo from Github
git clone https://github.com/alexcasche/markdup
  1. Install the dependencies
npm install or yarn install
  1. Start test suite
npm test or yarn run test
  1. Launch development server
npm start or yarn start

Tech Used

Markdup was built with the following libraries