Skip to content

lklynet/meerkat

Repository files navigation

meerkat

meerkat screenshot

A minimalist Markdown notepad. Write in Markdown, preview live, share with a link.

How it works

Type Markdown in the editor. Toggle between split view, editor-only, and preview-only. Every note gets a shareable URL.

  • Split view (default) — edit on the left, live preview on the right
  • Keyboard shortcutsCtrl+S save, Ctrl+N new note, Ctrl+P cycle views
  • Auto-save — saves as you type
  • Light mode per panel — toggle each side independently

Run

node server.js

Open http://localhost:3000.

Docker

docker compose up -d

The image is published to ghcr.io/lklynet/meerkat on push to main.

docker pull ghcr.io/lklynet/meerkat:latest
docker run -d -p 3000:3000 -v ./data:/app/data ghcr.io/lklynet/meerkat:latest

Stack

  • Vanilla JavaScript frontend, no framework
  • Node.js HTTP server, no framework
  • SQLite via node:sqlite
  • CodeMirror 5 for editing, marked.js + highlight.js for rendering
  • ~3 KB of handwritten CSS
  • Minimal Docker image (Alpine)

License

MIT

About

another minimalist markdown notepad

Resources

Stars

1 star

Watchers

1 watching

Forks

Packages

 
 
 

Contributors