# Patitas API Reference

URL: /patitas/api/
Section: api
Description: Browse Python API documentation by package.

---

> For a complete page index, fetch /patitas/llms.txt.

Open LLM text
(/patitas/api/index.txt)

Share with AI

Ask Claude
(https://claude.ai/new?q=Please%20help%20me%20understand%20this%20documentation%3A%20%2Fpatitas%2Fapi%2Findex.txt)

Ask ChatGPT
(https://chatgpt.com/?q=Please%20help%20me%20understand%20this%20documentation%3A%20%2Fpatitas%2Fapi%2Findex.txt)

Ask Gemini
(https://gemini.google.com/app?q=Please%20help%20me%20understand%20this%20documentation%3A%20%2Fpatitas%2Fapi%2Findex.txt)

Ask Copilot
(https://copilot.microsoft.com/?q=Please%20help%20me%20understand%20this%20documentation%3A%20%2Fpatitas%2Fapi%2Findex.txt)

# Patitas API Reference

Browse Python API documentation by package.

8
Packages

24
Modules

## Packages

Directives

Directive system for Patitas.

Provides extensible block-level markup through the directive...

7 items

(/patitas/api/directives/)

Lexer

Modular state-machine lexer for Patitas markdown parser.

This package provides a window-based lexer with O(n)...

5 items

(/patitas/api/lexer/)

Linting

Content linting for Patitas — a ruff-for-Markdown over the typed AST.

7 items

(/patitas/api/linting/)

Parsing

Parsing subsystem for Patitas Markdown parser.

Provides mixin classes for modular parsing functionality:
-...

10 items

(/patitas/api/parsing/)

Plugins

Plugin system for Patitas Markdown parser.

Plugins extend Patitas with additional syntax support:
- table:...

7 items

(/patitas/api/plugins/)

Renderers

Patitas renderers.

4 items

(/patitas/api/renderers/)

Roles

Role system for Patitas.

Provides extensible inline markup through the role syntax:

\{role}`content`

Roles are...

4 items

(/patitas/api/roles/)

Utils

Utility modules for Patitas.

4 items

(/patitas/api/utils/)

## Modules

cache

Content-addressed parse cache for Patitas.

Provides (content_hash, config_hash) -> Document caching to avoid...

(/patitas/api/cache/)

config

ContextVar-based parse configuration for Patitas.

Provides thread-local configuration using Python's ContextVars...

(/patitas/api/config/)

context

Content-aware context mapping for Patitas AST nodes.

Maps AST node types to the template context paths they affect.

(/patitas/api/context/)

differ

AST differ — structural diff on Patitas frozen ASTs.

Compares two Patitas Document trees and produces a changeset...

(/patitas/api/differ/)

errors

Exception classes for Patitas.

(/patitas/api/errors/)

excerpt

Extract plain-text excerpts from Patitas AST.

Provides structurally correct excerpt extraction that stops at block...

(/patitas/api/excerpt/)

frontmatter

YAML frontmatter parsing for Markdown and other content formats.

(/patitas/api/frontmatter/)

highlighting

Syntax highlighting protocol and injection for Patitas.

Provides optional syntax highlighting for code blocks.
When...

(/patitas/api/highlighting/)

icons

Icon resolver protocol and injection for Patitas.

Provides optional icon support for directives.

(/patitas/api/icons/)

incremental

Incremental re-parsing for Patitas ASTs.

When a user edits one paragraph, only that paragraph's region...

(/patitas/api/incremental/)

location

Source location tracking for error messages and debugging.

(/patitas/api/location/)

nodes

Typed AST nodes for Patitas.

(/patitas/api/nodes/)

notebook

Jupyter notebook (.ipynb) parser for Patitas.

Parses nbformat 4.x JSON to (markdown_content, metadata) in the same...

(/patitas/api/notebook/)

parser

Recursive descent parser producing typed AST.

(/patitas/api/parser/)

patitas

Patitas — Modern Markdown Parser for Python 3.14t

A CommonMark-compliant Markdown parser designed for free-threaded...

(/patitas/api/patitas/)

profiling

Patitas ParseAccumulator — opt-in profiling for Markdown parsing.

(/patitas/api/profiling/)

protocols

Protocols for Patitas.

(/patitas/api/protocols/)

sanitize

Composable sanitization policies for Patitas AST.

Provides immutable transform policies for stripping unsafe...

(/patitas/api/sanitize/)

serialization

AST serialization — JSON round-trip for Patitas AST nodes.

Converts typed AST nodes to/from JSON-compatible dicts.

(/patitas/api/serialization/)

stringbuilder

StringBuilder for O(n) string accumulation.

(/patitas/api/stringbuilder/)

text

Extract plain text from Patitas AST nodes.

(/patitas/api/text/)

tokens

Token and TokenType definitions for the Patitas lexer.

The lexer produces a stream of Token objects that the parser...

(/patitas/api/tokens/)

visitor

AST Visitor and Transformer for Patitas.

Provides a base visitor class with match-based dispatch and an...

(/patitas/api/visitor/)