8.6 KiB
8.6 KiB
Typst CLI Examples
Quick reference for common typst commands and markup patterns.
Installation Verification
# Check version
typst --version
# Get help
typst help
Compilation
Basic Compilation
# Compile to PDF (default)
typst compile document.typ
# Explicit output file
typst compile document.typ output.pdf
# Compile to PNG
typst compile document.typ document.png
# Compile to SVG
typst compile document.typ document.svg
Output Options
# High-resolution PNG (300 PPI)
typst compile --ppi 300 document.typ output.png
# Multi-page to numbered PNGs
typst compile document.typ 'output-{n}.png'
# Custom output directory
typst compile document.typ build/output.pdf
Root and Input
# Set root directory for imports
typst compile --root /project/src document.typ
# Pass input variables
typst compile --input version=2.0 document.typ
typst compile --input author="John Doe" --input date=2024-01-15 document.typ
Watch Mode
# Watch and recompile on changes
typst watch document.typ
# Watch with specific output
typst watch document.typ output.pdf
# Watch with PNG output
typst watch thesis.typ thesis.png
Font Management
# List all available fonts
typst fonts
# Filter fonts by name
typst fonts | grep -i "computer modern"
# Compile with custom font path
typst compile --font-path ./fonts document.typ
# Multiple font paths
typst compile --font-path ./fonts --font-path ~/Library/Fonts document.typ
Document Templates
Basic Document
// document.typ
#set page(paper: "a4", margin: 2.5cm)
#set text(font: "New Computer Modern", size: 11pt)
#set par(justify: true)
= Document Title
#lorem(50)
== First Section
#lorem(100)
=== Subsection
#lorem(75)
Academic Paper
// paper.typ
#set document(title: "Research Paper", author: "Author Name")
#set page(paper: "us-letter", margin: 1in)
#set text(font: "Times New Roman", size: 12pt)
#set par(justify: true, leading: 2em)
#set heading(numbering: "1.1")
#align(center)[
#text(size: 16pt, weight: "bold")[Paper Title]
#v(1em)
Author Name \
Institution \
#link("mailto:email@example.com")
#v(1em)
#datetime.today().display("[month repr:long] [day], [year]")
]
#v(2em)
*Abstract.* #lorem(80)
#v(1em)
= Introduction
#lorem(100)
= Methods
#lorem(100)
= Results
#lorem(100)
= Discussion
#lorem(100)
#bibliography("references.bib")
Letter
// letter.typ
#set page(paper: "us-letter", margin: 1in)
#set text(font: "Georgia", size: 11pt)
#align(right)[
Your Name \
123 Main Street \
City, State 12345 \
#datetime.today().display()
]
#v(2em)
Recipient Name \
456 Other Street \
City, State 67890
#v(1em)
Dear Recipient,
#lorem(150)
Sincerely,
#v(3em)
Your Name
Resume/CV
// resume.typ
#set page(paper: "us-letter", margin: 0.5in)
#set text(font: "Helvetica", size: 10pt)
#align(center)[
#text(size: 20pt, weight: "bold")[Your Name]
email\@example.com | (555) 123-4567 | linkedin.com/in/yourname
]
#line(length: 100%)
== Experience
*Senior Developer* | Company Name | 2020 - Present
- Led team of 5 developers on major product launch
- Implemented CI/CD pipeline reducing deployment time by 50%
*Developer* | Other Company | 2018 - 2020
- Built REST APIs serving 1M+ requests daily
- Mentored junior developers
#line(length: 100%)
== Education
*Master of Science, Computer Science* | University Name | 2018
*Bachelor of Science, Computer Science* | University Name | 2016
#line(length: 100%)
== Skills
*Languages:* Python, JavaScript, Rust, Go \
*Frameworks:* React, Django, FastAPI \
*Tools:* Docker, Kubernetes, AWS
Math Examples
Inline Math
The quadratic formula is $x = (-b plus.minus sqrt(b^2 - 4a c)) / (2a)$.
Einstein's equation $E = m c^2$ relates mass and energy.
The sum $sum_(i=1)^n i = (n(n+1))/2$ is well known.
Display Equations
The Gaussian integral:
$ integral_(-infinity)^infinity e^(-x^2) dif x = sqrt(pi) $
Maxwell's equations:
$ nabla dot bold(E) &= rho / epsilon_0 \
nabla dot bold(B) &= 0 \
nabla times bold(E) &= -pdv(bold(B), t) \
nabla times bold(B) &= mu_0 bold(J) + mu_0 epsilon_0 pdv(bold(E), t) $
Matrices
$ mat(
1, 2, 3;
4, 5, 6;
7, 8, 9;
) $
$ mat(delim: "[",
a, b;
c, d;
) $
Cases
$ f(x) = cases(
x^2 &"if" x >= 0,
-x^2 &"if" x < 0,
) $
Tables
Basic Table
#table(
columns: 3,
[Header 1], [Header 2], [Header 3],
[Cell 1], [Cell 2], [Cell 3],
[Cell 4], [Cell 5], [Cell 6],
)
Styled Table
#table(
columns: (1fr, 2fr, 1fr),
align: (left, center, right),
stroke: 0.5pt,
inset: 8pt,
table.header(
[*Name*], [*Description*], [*Value*],
),
[Alpha], [First item], [100],
[Beta], [Second item], [200],
[Gamma], [Third item], [300],
)
Data Table
#let data = csv("data.csv")
#table(
columns: data.first().len(),
..data.flatten()
)
Figures and Images
Basic Image
#image("photo.jpg", width: 50%)
Figure with Caption
#figure(
image("diagram.png", width: 80%),
caption: [System architecture overview],
) <fig:architecture>
As shown in @fig:architecture, the system consists of three layers.
Side-by-Side Figures
#grid(
columns: 2,
gutter: 1em,
figure(
image("before.png"),
caption: [Before optimization],
),
figure(
image("after.png"),
caption: [After optimization],
),
)
Code Blocks
Inline Code
Use the `print()` function to output text.
Code Block
```python
def fibonacci(n):
if n <= 1:
return n
return fibonacci(n-1) + fibonacci(n-2)
```
Code with Caption
#figure(
```rust
fn main() {
println!("Hello, world!");
}
```,
caption: [A simple Rust program],
)
Lists
Bullet List
- First item
- Second item
- Nested item
- Another nested item
- Third item
Numbered List
+ First step
+ Second step
+ Third step
Definition List
/ Term: Definition of the term
/ Another term: Its definition
Layout
Columns
#columns(2)[
#lorem(50)
#colbreak()
#lorem(50)
]
Grid
#grid(
columns: (1fr, 1fr),
rows: (auto, auto),
gutter: 1em,
[Cell 1], [Cell 2],
[Cell 3], [Cell 4],
)
Alignment
#align(center)[Centered text]
#align(right)[Right-aligned text]
#align(left + bottom)[Bottom-left aligned]
Spacing
Text before
#v(2em) // Vertical space
Text after
Word #h(1cm) spaced #h(1cm) out
References and Citations
Labels and References
= Introduction <intro>
See @intro for more details.
#figure(
image("fig.png"),
caption: [A figure],
) <fig:example>
As shown in @fig:example...
Bibliography
According to @smith2020, this is important.
Multiple citations @smith2020 @jones2021.
#bibliography("refs.bib", style: "ieee")
Data Import
JSON
#let data = json("data.json")
#data.name // Access fields
CSV
#let rows = csv("data.csv")
#for row in rows [
#row.at(0), #row.at(1)
]
YAML
#let config = yaml("config.yaml")
Title: #config.title
Scripting
Variables
#let title = "My Document"
#let author = "John Doe"
#title by #author
Functions
#let highlight(body) = {
box(fill: yellow, inset: 3pt, body)
}
This is #highlight[important] text.
Conditionals
#let draft = true
#if draft [
*DRAFT - DO NOT DISTRIBUTE*
]
Loops
#for i in range(1, 6) [
- Item #i
]
Advanced CLI
Batch Processing
# Compile all .typ files in directory
for f in *.typ; do
typst compile "$f"
done
# Compile with common settings
for f in chapters/*.typ; do
typst compile --font-path ./fonts "$f" "output/$(basename $f .typ).pdf"
done
CI/CD Integration
# Check compilation succeeds
typst compile document.typ && echo "Success" || echo "Failed"
# Compile and verify output exists
typst compile thesis.typ thesis.pdf
if [ -f thesis.pdf ]; then
echo "PDF generated successfully"
fi
Environment Setup
# Set font paths for session
export TYPST_FONT_PATHS="$HOME/fonts:/usr/share/fonts"
# Compile with custom root
export TYPST_ROOT="/project"
typst compile src/main.typ
Troubleshooting Commands
# Verbose output for debugging
typst compile document.typ 2>&1 | head -50
# Check available fonts
typst fonts | wc -l # Count fonts
# Find specific font
typst fonts | grep -i "fira"
# Test minimal document
echo '= Test' | typst compile - test.pdf