mdne - Markdown Neo Edit

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

Features

• Live preview of Markdown, HTML, LSX formats.
• Export Markdown, HTML, LSX into PDF or HTML.
• Code highlighting.
  • C#
  • CSS
  • GraphQL
  • HTML
  • JavaScript
  • JSON
  • Less
  • Lisp
  • Markdown
  • Protobuf
  • Python
  • Sass
  • Scss
  • shell script
  • SQL
  • SVG
  • 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)

Distributions and Integrations

• mdne
  • Offline desktop app for Google Chrome browser + Node.js.
    • This repository
    • Carlo app
• mdne-electron
  • Standalone offline desktop app for Windows/Mac/Linux.
    • Electron app
• mdne-for-kintone
  • Edit kintone record's field. (browser app)
• mdne online
  • Live demo (PWA)

Install

WARNING
node>=13.0.0 is not currently supported. (2019-10-29)

Prerequirements

• Google Chrome (latest)
• Node>=10

Install from NPM

• Linux

  env PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=TRUE npm install -g mdne

• Windows

  set PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=TRUE
  npm install -g mdne

• Chrome OS (Chromebook / Chromebox) Crostini

  env PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=TRUE npm install -g mdne
  cd
  mkdir Desktop

Create desktop and 'send to' menu shoorcuts (Windows)

• Download source zip archive from here.
• Extract zip archive and run make-shortcut.cmd.

  NOTE: To run on node>=12, run make-shortcut-node12.cmd instead.

Run

Open blank editor:

• Linux, Windows

  mdne
  
  ## To run on node>=12, use `mdne12` instead.

• Windows

  mdnew
  
  ## To run on node>=12, use `mdnew12` instead.

• Chrome OS (Chromebook / Chromebox) Crostini

  env MDNE_CHROME_CHANNEL_CHROMIUM=true mdne
  
  ## To run on node>=12, use `mdne12` instead.

  • MDNE_CHROME_CHANNEL_CHROMIUM=TRUE can alternatively be written to .bashrc.
  • Chromium is downloaded locally the first time it run.

Open file:

• Linux

  mdne README.md
  
  ## To run on node>=12, use `mdne12` instead.

• Windows

  mdnew README.md
  
  ## To run on node>=12, use `mdnew12` instead.

• Chrome OS (Chromebook / Chromebox) Crostini

  env MDNE_CHROME_CHANNEL_CHROMIUM=true mdne README.md
  
  ## To run on node>=12, use `mdne12` instead.

  • MDNE_CHROME_CHANNEL_CHROMIUM=TRUE can alternatively be written to .bashrc.
  • Chromium is downloaded locally the first time it run.

CLI

Please use Ménneu CLI.

Live demo

https://shellyln.github.io/mdne/

Open external files from live demo

• Drop a local file into FileDropOpenDialog.
• Set the target URL to a location hash.
  • example: react-dom.development.js
    • Fetching files is restricted by the Same-Origin Policy.
• Set zipped data to a location hash.
  • example: hello.md
    • location hash is generated when Save or SaveAs commands are done.

Live demo browser requirements

• Google Chrome: latest
• Firefox: latest

Live demo restrictions

• Rendering / exporting to PDF is not available.
• Save and SaveAs commands download the file being edited.

Security warning

Exposing of Node side functions by RPC is enabled in preview iframe.
DON'T OPEN links to untrusted sites from the preview.
Exposed functions have the ability to list / read / write local files.

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)