lenz-md
v0.1.6
Published
Native desktop Markdown preview that installs a platform-specific Lenz build from GitHub Releases.
Readme
Lenz
Native desktop Markdown preview (Tauri + TypeScript).
Features
- Live reload
- KaTeX math via
$$ ... $$ - Full CommonMark support thanks to markdown-it
- Vim Motions like
j,k,gg,G - Zoom:
Ctrl/Cmd +andCtrl/Cmd - - Press
ofor the file picker
Install
- Global CLI via npm:
npm install -g lenz-md
lenz notes.md- One-off run without a global install:
npx lenz-md notes.md- The npm package downloads the matching native build for your OS from GitHub Releases during installation.
- Manual download is still available from
releases/latest. - Or build from source (see Development).
Usage
lenz notes.mdIf you installed the package locally instead of globally, run it with npx lenz notes.md.
Development
Requirements
Run in development
bun install
bun run dev:appOpen an arbitrary file in dev:
bun tauri dev -- -- path/to/file.mdFixtures:
bun run dev:app:short
bun run dev:app:long
bun run dev:app:math
bun run dev:app:readmeBuild locally
bun run build
cargo check --manifest-path src-tauri/Cargo.toml
bun run tauri build