Skip to content

diversen/electron-markdown-editor

Repository files navigation

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 KaTeX, e.g.:

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

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

Install

Use npm:

Global:

npm install -g electron-markdown-editor

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 in development (Vite + Electron):

npm run dev:all

Run production build locally:

npm run build
npm run start

About

A simple electron markdown editor made with Uikit, Codemirror and markdown-it. Support for MathJax, code highlighting, live preview, and more.

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors