mdne-electron - Markdown Neo Edit for Electron
A simple markdown and code editor powered by Markdown-it, Ace and Electron.
Features
- Live preview of Markdown, HTML, LSX formats.
- Export Markdown, HTML, and LSX into PDF or HTML.
- Code highlighting.
- C#
- CSS
- Dockerfile
- Go
- GraphQL
- HTML
- INI
- Java
- JavaScript
- JSON
- JSON5
- JSX
- Kotlin
- Latex
- Less
- Lisp
- Makefile
- Markdown
- Protobuf
- Python
- R
- Ruby
- Rust
- Sass
- Scss
- Shell script
- SQL
- SVG
- Tex
- TOML
- TSX
- TypeScript
- XML
- YAML
- Markdown extended syntax
- Many markdown-it plugins are enabled. See here.
- Scripting and value expansion
- Full screen mode (F11)
Distributions and Integrations
-
mdne-electron
- Standalone offline desktop app for Windows/Mac/Linux.
-
mdne online
- Online markdown editor for Chrome/Chromium Edge/Firefox.
- This repository
-
PWA (Progressive Web Apps)
-
mdne-sf
- Edit Salesforce record's field. (browser app)
- Markdown preview Visualforce page example
-
mdne (mdne-classic)
- Offline desktop app for Google Chrome browser + Node.js.
-
mdne-for-kintone
- Edit kintone record's field. (browser app)
CLI
Please use Ménneu CLI.
Live demo (mdne online; PWA)
Live demo browser requirements
- Google Chrome: latest
- Chromium Edge: latest
- Firefox: latest
Live demo restrictions
- Rendering / exporting to PDF is not available.
- Save and SaveAs commands download the file being edited.
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
Build for production
npm run build
Build for production (only electron main process)
npm run build:mainproc
Build for production (only electron renderer process)
npm run build:renderer
Build mdne online PWA app
npm run build:browser
Clean project
npm run clean
Start electron app for debug
npm start
Build electron distribution executable files (unpacked)
# npm run clean
# npm run build
npm run dist:unpacked
Build electron distribution executable files (packing to the installer)
# npm run clean
# npm run build
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 tests
npm run test
Linting
npm run lint
Change window title bar color (Windows)
Windows Registry Editor Version 5.00
[HKEY_CURRENT_USER\SOFTWARE\Microsoft\Windows\DWM]
"ColorPrevalence"=dword:00000001
"AccentColor"=dword:00242120
"AccentColorInactive"=dword:0043403c
Electron Documentation (security)
See this guide.
License
ISC
Copyright (c) 2019-2020 Shellyl_N and Authors.
Bundled softwares' license