richtext-typst 0.1.0

Convert Rich Text JSON to Typst

Rich Text JSON to Typst Converter

Convert rich text JSON documents (from editors like ProseMirror, Quill, Slate) to Typst markup.

Features

• Supports multiple formats: Quill, Slate, ProseMirror (extensible)
• Simple API: One function to convert any supported format
• Custom parser support: Register your own parser for new formats

---

Installation

This project requires Python 3.10+ and uv for development.

Clone the repo and install dependencies:

uv pip install -e .

---

Usage

Basic Example

from richtextjson2typst import convert

# Example: Quill JSON
quill_json = {"ops": [{"insert": "Hello", "attributes": {"bold": True}}]}
typst = convert(quill_json, "quill")
print(typst)  # Output: *Hello*

Supported Formats

• prosemirror: ProseMirror JSON
• quill: Quill.js Delta JSON (Soon)
• slate: Slate.js JSON (Soon)

API

convert(data: dict, fmt: str | BaseParser) -> str

• data: The rich text JSON object
• fmt: Format name ("quill", "slate", "prosemirror") or a custom parser instance
• Returns: Typst markup as a string

Registering a Custom Parser

from richtextjson2typst import register_parser, BaseParser

class MyParser(BaseParser):
		def parse(self, data: dict) -> str:
				return f"#myformat[{data['text']}]
"
register_parser("myformat", MyParser())

---

Testing

Run all tests:

uv run pytest

---

Project Structure

• src/richtextjson2typst/ — Main package
  • converter.py — Format dispatch and API
  • base.py — Parser interface
  • exceptions.py — Error types
  • formats/ — Built-in format parsers (Quill, Slate, ProseMirror)
• tests/ — Unit and robustness tests

---

License

MIT License. See LICENSE.