Skip to content

Repository files navigation

KW Markdown Viewer

A lightweight Tauri desktop Markdown viewer with live preview, syntax highlighting, and Mermaid diagram support.

Install with Homebrew

Add the tap once, then install the app:

brew tap nsisodiya/kw-markdown-viewer https://github.com/nsisodiya/kw-markdown-viewer
brew trust nsisodiya/kw-markdown-viewer
brew install --cask kw-markdown-viewer

Homebrew 6 and newer require the one-time brew trust command for third-party cask taps.

The first release is not Apple-notarized. If macOS blocks the first launch, right-click KW Markdown Viewer in Applications and choose Open.

Upgrade

Homebrew automatically sees new versions after each GitHub release:

brew update
brew upgrade --cask kw-markdown-viewer

Check the installed version with:

brew info --cask kw-markdown-viewer

Development

Install dependencies

Install the Tauri prerequisites for your platform, including Rust, then run:

npm install

Run locally

npm run tauri:dev

Build

npm run build:mac
npm run build:win
npm run build:linux

Releasing

  1. Set the same semantic version in package.json, package-lock.json, src-tauri/Cargo.toml, and src-tauri/tauri.conf.json.
  2. Commit the version change.
  3. Tag the commit (for example, v1.1.0) and push the tag.

The release workflow builds a universal Tauri macOS DMG and ZIP, creates the GitHub release, calculates the DMG SHA-256, and commits the updated Homebrew cask. Homebrew users can then upgrade with the command above.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages