mdne-electron - Markdown Neo Edit for Electron

A simple markdown and code editor powered by Markdown-it, Ace and Electron.

For details and features, please refer to Original version of mdne (for Carlo).

Features

• Live preview of Markdown, HTML, LSX formats.
• Export Markdown, HTML, LSX into PDF or HTML.
• Code highlighting.
  • C#
  • CSS
  • Dockerfile
  • Go
  • GraphQL
  • HTML
  • JavaScript
  • JSON
  • JSON5
  • JSX
  • Latex
  • Less
  • Lisp
  • Makefile
  • Markdown
  • Protobuf
  • Python
  • R
  • Ruby
  • Rust
  • Sass
  • Scss
  • Shell script
  • SQL
  • SVG
  • Tex
  • TSX
  • TypeScript
  • XML
  • YAML
• Markdown extended syntax
  • Many markdown-it plugins are enabled. See here.
• Scripting and value expansion
  • See here.
• Full screen mode (F11)

Requirements

• [Optional] Google Chrome (latest)
  • for previewing as or exporting as PDF

Build scripts

Project setup

npm ci

# npm install    # it causes a dependency update

Compiles for production

npm run build

Compiles for production (only electron main process)

npm run build:mainproc

Clean project

npm run clean

Start electron app for debug

npm run start

Build electron distribution executable files (unpacked)

npm run pack

Build electron distribution executable files (packing to the installer)

npm run dist          # build for current machine

# npm run dist:win    # build for windows (x64)
# npm run dist:linux  # build for linux (x64)
# npm run dist:mac    # build for macos (x64)

Run your tests

npm run test

Lints and fixes files

npm run lint

Electron Documentation (security)

See this guide.

License

ISC
Copyright (c) 2019 Shellyl_N and Authors.

Bundled softwares' license

• Ace: license (BSD-3-Clause)
• Materialize: license (MIT)
• Normalize.css: license (MIT)
• React: license (MIT)
• pako: license (MIT + ZLIB)
• dialog-polyfill: license (BSD-3-Clause)