Skip to content

A library and CLI tool for rendering Markdown documents with syntax highlighting and rich text formatting.

Notifications You must be signed in to change notification settings

harehare/mq-view

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mq-view

ci

A library and CLI tool for rendering Markdown documents with syntax highlighting and rich text formatting. Built with mq - jq-like command-line tool for markdown processing.

demo

Features

  • 🎨 Syntax Highlighting: Tree-sitter powered syntax highlighting for 13+ programming languages
  • 📝 Rich Markdown Rendering: Support for headers, lists, code blocks, links, images, and more
  • 🔔 GitHub-style Callouts: NOTE, TIP, IMPORTANT, WARNING, CAUTION
  • 🔗 Clickable Links: Terminal hyperlinks using OSC 8

Installation

Quick Install

curl -sSL https://raw.githubusercontent.com/harehare/mq-view/refs/heads/main/bin/install.sh | bash

The installer will:

  • Download the latest mq-view binary for your platform
  • Install it to ~/.mq/bin/
  • Update your shell profile to add mq-view to your PATH

Cargo

$ cargo install --git https://github.com/harehare/mq-view.git
$ cargo install mq-view

Supported Languages

  • Rust, JavaScript, TypeScript (+ TSX)
  • Python, Go, Java
  • C, C++
  • HTML, CSS, JSON
  • Bash/Shell

Usage

As a CLI Tool

View a markdown file:

mq-view README.md

Pipe markdown content:

echo "# Hello\n\n\`\`\`rust\nfn main() {}\n\`\`\`" | mq-view

License

MIT

About

A library and CLI tool for rendering Markdown documents with syntax highlighting and rich text formatting.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published