Skip to main content

Rich-based Markdown console renderer (mdcat) with emoji, LaTeX math, and preprocessing helpers.

Project description

madcatter

Render Markdown to the terminal with Rich.

madcatter provides the mdcat CLI: a Markdown console renderer with left-justified headings, :shortcode: emoji expansion, LaTeX-to-Unicode math ($...$ and $$...$$), syntax-highlighted code blocks, a table-of-contents view, link extraction and validation, ASCII/HTML/ANSI export, and tail -F-style follow and watch modes.

Install

pip install madcatter

Usage

mdcat README.md              # render a file
mdcat -                      # render stdin
mdcat --toc README.md        # show the table of contents
mdcat --style dracula doc.md # use a predefined color profile

Run mdcat --help for the full flag list.

Library

The preprocessing helpers are importable directly:

from madcatter.markdown import process_math_blocks, strip_frontmatter
from madcatter.latex import latex2unicode
from madcatter.emoji import resolve

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

madcatter-0.1.0.tar.gz (123.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

madcatter-0.1.0-py3-none-any.whl (71.2 kB view details)

Uploaded Python 3

File details

Details for the file madcatter-0.1.0.tar.gz.

File metadata

  • Download URL: madcatter-0.1.0.tar.gz
  • Upload date:
  • Size: 123.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for madcatter-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b96ea4488ae76d02321f84e962a2c09f39f833ced23fe3f9548ed6aedbe3ee8e
MD5 4e316b6c74b552b7787c716c948ee46e
BLAKE2b-256 7c99449dc8d24d280064b2f02d67949a7e7377d35c5915f1aae0d95540eebb14

See more details on using hashes here.

File details

Details for the file madcatter-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: madcatter-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 71.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for madcatter-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bee093f0dd002c962120feb4b7c1e68c888710e464badf7884beee96057aaaee
MD5 66c9fbb5e0e902330cd362da0df5beeb
BLAKE2b-256 46c7591e206a167734eb1310fed576bc458ef6ee5412b67babdeef328d510026

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page