Skip to content

About

Markdown editor and reader for Omarchy. Ctrl+E to toggle edit/view.

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

33 Commits

Folders and files

Repository files navigation

markinator

Markdown editor and reader for Omarchy.

One window. Write markdown. Press Ctrl+E. Read it rendered. Press Ctrl+E again. Back to writing.

It uses your Omarchy theme colors and font. Change the theme and the app follows, no restart.

Features

  • Edit and view in one window. Ctrl+E switches.
  • Your Omarchy theme colors and font, updated live when the theme changes.
  • Markdown colors while you write (headings, lists, bold, code, links).
  • Find in the file, word count, recent files.
  • Export to HTML. Print, or save as PDF.
  • Remembers where you were in each file.
  • Many files open as windows of one app, so it stays light on memory.

Install

One line, no sudo. Puts the binary in ~/.local/bin and adds the launcher entry and icon:

curl -fsSL https://raw.githubusercontent.com/smanookian/markinator/main/install.sh | sh

Read install.sh first if you like; it is short.

Build from source

Needs Rust and webkit2gtk-4.1 (already on Omarchy).

git clone https://github.com/smanookian/markinator
cd markinator/src-tauri
cargo build --release
install -Dm755 target/release/markinator ~/.local/bin/markinator
install -Dm644 ../markinator.desktop ~/.local/share/applications/markinator.desktop
install -Dm644 ../icons/markinator.svg ~/.local/share/icons/hicolor/scalable/apps/markinator.svg

Or build the Arch package: makepkg -si in the repo root (needs a released tag; it downloads the tarball).

Make it the default for markdown files:

xdg-mime default markinator.desktop text/markdown

Note: on Hyprland, xdg-open asks file for the type, and file calls .md files text/plain. Install perl-file-mimeinfo (sudo pacman -S perl-file-mimeinfo) and xdg-open notes.md will pick markinator. gio open notes.md works without it.

Use

markinator               # empty document
markinator notes.md      # open a file (starts in view mode)
markinator -e notes.md   # open a file in edit mode
markinator --version     # show the version
markinator --help        # show options and keys

Keys

Key Action
Ctrl+E Toggle edit / view
Ctrl+O Open
Ctrl+S Save
Ctrl+Shift+S Save as
Ctrl+N New document
Ctrl+P Print, or save as PDF ("Print to File")
Ctrl+Shift+E Export as HTML
Ctrl+R Recent files (Enter open, Esc close)
Ctrl+F Find (Enter next, Shift+Enter back, Esc close)
Ctrl+Q Close window
Ctrl++ / Ctrl+- / Ctrl+0 Zoom in / out / reset

In edit mode, Tab inserts two spaces.

Notes

  • Links to http(s):// open in your browser. Links to .md files open in the same window.
  • If the file changes on disk and you have no unsaved edits, it reloads.
  • Opening more files while markinator runs adds windows to the same app. This uses less memory.
  • Edit mode colors markdown (headings, lists, bold, code, links). Files over 200 KB stay plain, so typing stays fast.
  • The status line shows the word count. Markdown marks like # or - are not counted.
  • Window size is remembered, and where you were in each file (last 100 files).
  • Window class is markinator, for Hyprland window rules.

License

MIT

About

Markdown editor and reader for Omarchy. Ctrl+E to toggle edit/view.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages