Metadata-Version: 2.4
Name: madcatter
Version: 0.1.0
Summary: Rich-based Markdown console renderer (mdcat) with emoji, LaTeX math, and preprocessing helpers.
Project-URL: Homepage, https://www.rekursiv.ai
Project-URL: Repository, https://github.com/rekursiv-ai/madcatter
Project-URL: Documentation, https://github.com/rekursiv-ai/madcatter/tree/main/docs
Project-URL: Source, https://github.com/rekursiv-ai/madcatter
Project-URL: Issues, https://github.com/rekursiv-ai/madcatter/issues
Project-URL: Changelog, https://github.com/rekursiv-ai/madcatter/releases
Author-email: "rekursiv.ai" <hello@rekursiv.ai>
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: cli,console,markdown,renderer,rich,terminal
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Terminals
Classifier: Topic :: Text Processing :: Markup :: Markdown
Requires-Python: >=3.12
Requires-Dist: markdown-it-py>=3.0
Requires-Dist: pylatexenc>=2.10
Requires-Dist: requests>=2.28
Requires-Dist: rich>=13.0
Description-Content-Type: text/markdown

# madcatter

Render Markdown to the terminal with [Rich](https://github.com/Textualize/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

```bash
pip install madcatter
```

## Usage

```bash
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:

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