electron-markdown-editor

A markdown editor built with electron, uikit, and markdown-it

Usage no npm install needed!

<script type="module">
  import electronMarkdownEditor from 'https://cdn.skypack.dev/electron-markdown-editor';
</script>

README

Electron markdown editor

Screenshot

Screenshot

A markdown editor for the desktop using:

Features

  • WYSIWYG

  • Shortcuts (ctrl-S, Ctrl-O) save and open

  • Dialog for image

  • Dialog for videos (mp4)

  • Dialog for tables

  • Live preview of code highlight.js with tiles, e.g.:

    ~~~php <?php

    echo "hello world";

    ?> ~~~

Becomes:

<?php

echo "hello world";

?>
  • Live preview of Math MathJax, e.g.:

$\sum_{i=0}^n i^2 = \frac{(n^2+n)(2n+1)}{6}$

(You will not be able to see parsing of MathJax on github.com or npmjs.com - but only when using the editor).

Install

Use npm:

Global:

sudo npm install electron-markdown-editor -g

You can specify a file on the commandline. E.g.:

electron-markdown-editor README.md

Development:

git clone https://github.com/diversen/electron-markdown-editor
cd electron-markdown-editor 
npm install

Run electron-markdown-editor:

./bin/electron-markdown-editor README.md