Skip to content

thinkter/lenz

Repository files navigation

Lenz

Native desktop Markdown preview (Tauri + TypeScript). image

Features

  • Live reload
  • KaTeX math via $$ ... $$
  • Full CommonMark support thanks to markdown-it
  • Vim Motions like j, k, gg, G
  • Zoom: Ctrl/Cmd + and Ctrl/Cmd -
  • Press o for 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.md

If you installed the package locally instead of globally, run it with npx lenz notes.md.

Development

Requirements

  • Bun
  • Rust
  • Tauri system dependencies for your platform (see Tauri docs)

Run in development

bun install
bun run dev:app

Open an arbitrary file in dev:

bun tauri dev -- -- path/to/file.md

Fixtures:

bun run dev:app:short
bun run dev:app:long
bun run dev:app:math
bun run dev:app:readme

Build locally

bun run build
cargo check --manifest-path src-tauri/Cargo.toml
bun run tauri build

About

Markdown Viewer made in Tauri

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors