typst
Typst document creation and package development. Use when: (1) Working with .typ files, (2) User mentions typst, typst.toml, or typst-cli, (3) Creating or using Typst packages, (4) Developing document templates, (5) Converting Markdown/LaTeX to Typst
- Installs
- 2.1K
- Last 24h
- +22
- Trending rank
- #5368
- Security
- Not audited
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/lucifer1004/claude-skill-typst --skill typst- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads typst automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
SKILL.md
The instructions your agent reads when the skill is triggered.
Typst
This skill targets Typst 0.15+. For Typst 0.14.2, use the typst-0.14.2
repository tag for the previous skill snapshot.
Compilation
typst compile document.typ # compile once → PDF
typst compile document.typ output.pdf # explicit output path
typst compile document.typ -f png # export as PNG image
typst compile src/main.typ --root . # set project root for /path imports
typst watch document.typ # recompile on change
typst eval --in document.typ 'query(heading).len()' # Typst 0.15+ introspection
For command options beyond this quick reference, see cli.md.
Agent verification — choose by what you need to check (see debug.md for details):
| Method | Command | Best for |
|---|---|---|
| HTML export | typst compile doc.typ /dev/stdout -f html --features html 2>/dev/null | Text content, structure, headings, tables |
| PNG export | typst compile doc.typ page-{p}.png -f png | Visual layout, alignment, spacing, fonts |
| pdftotext | typst compile doc.typ && pdftotext doc.pdf - | Fallback for page-specific content |
Minimal Document
#set page(paper: "a4", margin: 2cm)
#set text(size: 11pt)
= Title
Content goes here.
Writing Documents
Starting a new document? Copy the closest recipe from Examples below — it's faster than starting blank and each row names the docs to read next.
| When you need to... | Read |
|---|---|
| Learn syntax, imports, functions, control flow | basics.md |
| Learn data types, operators, string/array methods | types.md |
| Style pages, headings, figures, layout | styling.md |
| Tables, grids, cell spans, borders, data tables | tables.md |
| Academic papers, bibliography, theorems, equations | academic.md |
| Convert from Markdown or LaTeX | conversion.md |
| Upgrade older Typst code, 0.15 breaking changes | migration.md |
| Use Typst CLI commands and build options | cli.md |
| Extract data from documents, multi-pass builds | query.md |
Developing Packages and Templates
| When you need to... | Read |
|---|---|
State, counters, in-document query(), XML | advanced.md |
| CLI introspection, metadata export, multi-pass | query.md |
| Create a reusable template function | template.md |
| Create or publish a package | package.md |
| Verify output (HTML/PNG/pdftotext, repr) | debug.md |
| Profile performance (--timings, hotspots) | perf.md |
basics.md and types.md are also the foundation for developers.
Finding Packages
Search the embedded index of Typst Universe packages (updated weekly):
python3 scripts/search-packages.py "what you need"
python3 scripts/search-packages.py "chart" --category visualization
python3 scripts/search-packages.py --category cv --top 5
python3 scripts/search-packages.py --list-categories
Common Errors
| Error | Cause | Fix |
|---|---|---|
| "unknown variable" | Undefined identifier | Check spelling, ensure #let before use |
| "expected X, found Y" | Type mismatch | Check function signature in docs |
| "file not found" | Bad import path | Paths resolve relative to current file |
| "unknown font" | Font not installed | Use system fonts or web-safe alternatives |
| "maximum function call depth exceeded" | Deep recursion | Use iteration instead |
| "can only be used when context is known" | Missing context wrapper | Wrap in context { ... } |
| "unexpected argument" | = instead of : for args | Named args use : syntax: func(name: value) |
| "variables from outside are read-only" | Mutating captured variable | Use loop accumulation or state() — see advanced.md |
| "expected content, found string" (or vice versa) | Content/string type mismatch | Use [#str-var] to embed string in content |
| set/show rule has no effect | Rule placed after content | Place set/show rules before the content they target |
Examples
Copy the closest starter, adjust, compile. For CVs, letters, or slides, search packages: python3 scripts/search-packages.py --category cv (or letter, presentation).
| Example | Start here when you want... | Next read |
|---|---|---|
| basic-document.typ | A short note or memo | basics.md, styling.md |
| styled-document.typ | A multi-section report with page styling | styling.md, tables.md |
| template-report.typ | A reusable template for a series | template.md |
| tables-showcase.typ | A data-heavy doc (tables, CSV/JSON) | tables.md, types.md |
| academic-paper.typ | A paper with citations, theorems, math | academic.md |
| query-export.typ | Metadata export or multi-pass builds | query.md |
| package-example/ | A publishable package | package.md |
Dependencies
- typst CLI 0.15+ recommended: Install from https://typst.app or via package manager
- macOS:
brew install typst - Linux:
cargo install typst-cli - Windows:
winget install typst
- macOS:
- pdftotext (optional): For text-level output verification
- Python 3.10+ (optional): For package search and validation scripts
- jq (optional): For parsing JSON output from
typst evalin shell scripts
API Reference Search
Search the embedded index of Typst API functions, methods, and constructors:
python3 scripts/search-api.py "image width fit"
python3 scripts/search-api.py "color lighten" --kind method
python3 scripts/search-api.py --name str.position -v
python3 scripts/search-api.py "rightarrow" --kind symbol # LaTeX names work
python3 scripts/search-api.py --list-categories
Ecosystem Tools
Ecosystem tools: tinymist (LSP/editor), typstyle (formatter), typst-package-check (package validator), tytanic (visual test runner). For package tooling details, see package.md.
FAQ
What does the typst skill do?
Typst document creation and package development. Use when: (1) Working with .typ files, (2) User mentions typst, typst.toml, or typst-cli, (3) Creating or using Typst packages, (4) Developing document templates, (5) Converting Markdown/LaTeX to Typst
How do I install typst?
Run npx skills add https://github.com/lucifer1004/claude-skill-typst --skill typst in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/typst/ (personal) or .claude/skills/typst/ (project).
Which AI agents can use typst?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is typst safe to install?
No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.
Who maintains typst?
It is published by lucifer1004 in lucifer1004/claude-skill-typst. It has 2,064 recorded installs.
Popular docs & writing skills
grill-with-docs
mattpocock/skills
A relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.
lark-markdown
open.feishu.cn
飞书 Markdown：查看、创建、上传、编辑和比较飞书中的原生 Markdown 文件。当用户要操作飞书 Markdown 文件，或比较其远端版本及本地草稿时使用。纯本地 Markdown 文件操作不触发本 skill。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。
writing-beats
mattpocock/skills
Writing, exploit; assemble raw material into a journey of beats, grounding each term before a beat leans on it.
writing-shape
mattpocock/skills
Writing, exploit: shape raw material into an article, paragraph by paragraph.
writing-fragments
mattpocock/skills
Writing, explore: mine raw fragments, no structure yet.
writing-for-agents
mattpocock/skills
Writing documents for agents. Use when creating or editing skills, or modifying AGENTS.md or CLAUDE.md.