typst

Category: Docs & Knowledge | Uploader: lucifer1004 | Downloads: 0 | Version: v1.0（Latest）

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

Changelog: Source: GitHub https://github.com/lucifer1004/claude-skill-typst

Directory Structure

Current level: skills/typst/

📁 data/
- 📄 packages-bm25.json 256.1 KB
- 📄 packages.json 400.6 KB
📁 examples/
- 📁 package-example/
  - 📁 src/
    
    📄 boxes.typ 1.4 KB
    
    📄 formatting.typ 1015 B
  - 📄 lib.typ 792 B
  - 📄 README.md 1.9 KB
  - 📄 typst.toml 381 B
- 📄 academic-paper.typ 3.7 KB
- 📄 basic-document.typ 2.5 KB
- 📄 perf-test.typ 769 B
- 📄 styled-document.typ 2.5 KB
- 📄 tables-showcase.typ 2.6 KB
- 📄 template-report.typ 6.0 KB
📁 scripts/
- 📄 perf-timings.py 10.0 KB
- 📄 search-packages.py 11.9 KB
- 📄 validate-examples.py 7.6 KB
📄 academic.md 6.0 KB
📄 advanced.md 4.2 KB
📄 basics.md 7.0 KB
📄 conversion.md 7.4 KB
📄 debug.md 5.3 KB
📄 LICENSE 1.0 KB
📄 package.md 4.4 KB
📄 perf.md 2.9 KB
📄 README.md 2.4 KB
📄 SKILL.md 5.7 KB
📄 styling.md 3.7 KB
📄 tables.md 5.1 KB
📄 template.md 3.7 KB
📄 types.md 4.1 KB

SKILL.md

---
name: typst
description: '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'
---

# Typst

Modern typesetting system — simpler than LaTeX, faster compilation, programmable.

## Compilation

```bash
typst compile document.typ              # compile once
typst compile document.typ output.pdf   # explicit output path
typst compile src/main.typ --root .     # set project root for /path imports
typst watch document.typ                # recompile on change
```

Agents cannot preview PDFs. Verify via exit code and `pdftotext`:

```bash
typst compile document.typ && pdftotext document.pdf - | head -20
```

## Minimal Document

```typst
#set page(paper: "a4", margin: 2cm)
#set text(size: 11pt)

= Title

Content goes here.
```

## Writing Documents

| When you need to...                                | Read                           |
| -------------------------------------------------- | ------------------------------ |
| Learn syntax, imports, functions, control flow     | [basics.md](basics.md)         |
| Learn data types, operators, string/array methods  | [types.md](types.md)           |
| Style pages, headings, figures, layout             | [styling.md](styling.md)       |
| Tables, grids, cell spans, borders, data tables    | [tables.md](tables.md)         |
| Academic papers, bibliography, theorems, equations | [academic.md](academic.md)     |
| Convert from Markdown or LaTeX                     | [conversion.md](conversion.md) |

**Start with [basics.md](basics.md)** — it covers modes, imports, functions, control flow, and common pitfalls. For data types and operators, see [types.md](types.md).

## Developing Packages and Templates

| When you need to...                       | Read                       |
| ----------------------------------------- | -------------------------- |
| Use state, context, query, or parse XML   | [advanced.md](advanced.md) |
| Create a reusable template function       | [template.md](template.md) |
| Create or publish a package               | [package.md](package.md)   |
| Debug output (pdftotext, repr, measure)   | [debug.md](debug.md)       |
| Profile performance (--timings, hotspots) | [perf.md](perf.md)         |

[basics.md](basics.md) and [types.md](types.md) are also the foundation for developers.

## Finding Packages

Search the embedded index of Typst Universe packages (updated weekly):

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

### Import Pattern

```typst
#import "@preview/package-name:version": *
#import "@preview/package-name:version": specific-func
```

## 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

| Example                                             | Description                                          |
| --------------------------------------------------- | ---------------------------------------------------- |
| [basic-document.typ](examples/basic-document.typ)   | Complete beginner document with all common elements  |
| [styled-document.typ](examples/styled-document.typ) | Set/show rules, page layout, multi-region document   |
| [template-report.typ](examples/template-report.typ) | Reusable template with headers, counters, note boxes |
| [tables-showcase.typ](examples/tables-showcase.typ) | Table features: spans, stripes, grids, data gen      |
| [academic-paper.typ](examples/academic-paper.typ)   | Paper with theorems, equations, bibliography layout  |
| [package-example/](examples/package-example/)       | Minimal publishable package with submodules          |

## Dependencies

- **typst CLI**: Install from https://typst.app or via package manager
  - macOS: `brew install typst`
  - Linux: `cargo install typst-cli`
  - Windows: `winget install typst`
- **pdftotext** (optional): For text-level output verification
- **Python 3.8+** (optional): For package search script

Comments 0

Latest | Hot

Please login before commenting.

No comments yet. Be the first one!

typst

Directory Structure

SKILL.md

Report

Notice