Typst Skill for Claude Code

A comprehensive skill for Typst document creation and package development.

Installation

One-line install:

npx skills add https://github.com/lucifer1004/claude-skill-typst

Manual install:

git clone https://github.com/lucifer1004/claude-skill-typst.git ~/.claude/skills/typst

Quick Start

# Compile a minimal document
cat > /tmp/hello.typ <<'EOF'
#set page(paper: "a4", margin: 2cm)
= Hello Typst

This is a minimal document.
EOF

typst compile /tmp/hello.typ

Verify output (HTML export for agents, PNG for visual checks):

typst compile /tmp/hello.typ /dev/stdout -f html --features html 2>/dev/null
typst compile /tmp/hello.typ "page-{p}.png" -f png

Contents

File	Audience	Description
SKILL.md	Both	Main entry point with quick reference
basics.md	Both	Language fundamentals, imports, functions
types.md	Both	Data types, operators, string/array/dict/color/datetime
styling.md	Users	Set/show rules, page layout, images, fonts, figures
tables.md	Users	Tables, grids, cell spans, borders, data tables
academic.md	Users	Papers, bibliography, theorems, equations
conversion.md	Users	Markdown/LaTeX to Typst conversion
query.md	Both	CLI typst query, metadata export, multi-pass builds
advanced.md	Developers	State, context, query, content introspection, XML
template.md	Developers	Reusable template function patterns
package.md	Developers	Package development, testing, and publishing
debug.md	Developers	Verification methods (HTML/PNG/pdftotext)
perf.md	Developers	Performance profiling and timings
examples/	Both	Runnable examples
agents/	Agents	Specialized agents (typst-verify, typst-package-qa)

Search Tools

# Search Typst packages
just search-pkg "chart visualization"

# Search Typst API (functions, methods, types, symbols)
just search-api "image width fit"
just search-api "rightarrow" --kind symbol   # LaTeX names work
just search-api --name str.position -v       # Exact lookup

Development

just              # List all recipes
just check        # Run lint + test + validate
just test         # Run test suite
just validate     # Validate inline Typst code blocks in docs
just stats        # Show project stats

Usage

Once installed, Claude Code will automatically activate this skill when:

• Working with .typ files
• User mentions "typst" or related terms
• Creating or modifying Typst documents

Requirements

• Typst CLI installed
• just (optional, for development)
• pixi (optional, for development)

License

MIT