Skip to content

Toobiass/Marki

Repository files navigation

Marki 🖋️

Marki is a minimalist, modern, and high-performance Markdown editor built with Angular and Electron. It is designed for writers who value speed, aesthetic, and a distraction-free environment.

Marki Main Interface


Features

  • Real-time Preview: See your Markdown render instantly side-by-side.
  • Smart Formatting: Wrap words in bold or italic with a single shortcut, even when no text is selected.
  • Smart Tabbed Navigation: Tab out of code blocks, bold markers, and links with ease.
  • Image Support: Simply paste an image from your clipboard, and Marki handles the rest (saves it locally and inserts the Markdown link).
  • Recent Files: Quickly jump between your last edited documents with the "Quick Open" overlay.
  • Auto-Save: Your work is protected with debounced auto-save and an unsaved changes guard.

Quick Open Interface

  • PDF Export: Turn your notes into clean, professional PDF documents.
  • Customizable UI: Support for Dark/Light mode and different layout presets (Split view, Editor-only, Preview-only).

Settings Interface


Shortcuts

Efficiency is at the core of Marki. Use these shortcuts to stay in the flow:

File Management

Shortcut Action
Ctrl + N New Document
Ctrl + O Open File
Ctrl + O Quick Open (Recent Files)
Ctrl + S Save Document
Ctrl + E Export as PDF
Ctrl + P Set Default Working Directory
Ctrl + , Open Settings

Editing & Formatting

Shortcut Action
Ctrl + B Bold / Toggle Bold
Ctrl + I Italic / Toggle Italic
Ctrl + H Cycle Header Level (#, ##, ###)
Ctrl + K Insert Hyperlink
Ctrl + Shift + C Insert Code Block / Wrap in Code
Ctrl + Z Undo
Ctrl + Y Redo
Alt + ↑ / ↓ Move Current Line Up / Down
Tab Smart-jump out of markers (`, **, ], )

Setup & Installation

1. Prerequisites

Ensure you have Node.js (LTS version) installed.

2. Installation

npm install

3. Development

npm start

4. Build Installers

To generate a production-ready installer for your system:

Windows

npm run make-installer

Linux

npm run make-linux

Made by Tobias

About

A minimalist, modern and high-performance Markdown editor built with Angular and Electron.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors