/markup

An app to view and edit markdown files.

Primary LanguageTypeScript

MarkUp



An app to view and edit markdown files, written in TypeScript and supported by Electron + ReactJS 👾

 

✅ Features

  • Live preview
  • GitHub Flavoured Markdown
  • HTML to Markdown
  • Auto scroll to new content
  • Ease-to-save (Type CTRL + S to save, if new, will open a dialog)
  • Easy-to-use

 

♻️ Changelog (v1.0.3)

  • Moved menu to left side
  • Fixed responsivity
  • Solved the bug that when open the dialog and cancel crash the page
  • When creating or opening a file, if unsaved, will pop up a dialog to confirm
  • When typing a new content on bottom, the viewer will scroll automaticatilly
  • Added some pre-built binaries, check tags page
  • Some fixes

 

🔥 Todo

  • Add "unsaved" and "saved" status
  • Add more plugins to improve funcionality
  • Add builds for each platform (Windows, Linux)
  • Ident on tab
  • Remap all styles
  • Better images support

 

🔧 Setup

  • Clone this repository:
git clone https://github.com/z3oxs/markup
cd markup

 

  • Build:
    yarn build or npm run build

 

  • Run:
    yarn start or npm run start

 

  • Create a self-packaged binary (based on your OS):
    yarn package or npm run package