Skip to content

Document page-numbering for format: typst #1796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Document page-numbering for format: typst #1796

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63ed63c
Document page-numbering for format: typst
cwickham Oct 7, 2025
e168ad1
Use `false` to omit numbering
cwickham Oct 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion docs/output-formats/typst.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Since Typst is under active development, there are still some limitations to Qua

## Page Layout

You can control the size of the page (`papersize`), the page margins (`margin`), and the number of columns used for page content (`columns`). For example, the following YAML modifies all three options:
You can control the size of the page (`papersize`), the page margins (`margin`), the number of columns used for page content (`columns`), and the page numbering (`page-numbering`). For example, the following YAML modifies the first three options:

```yaml
---
Expand Down Expand Up @@ -119,6 +119,15 @@ Then, any unspecified margins will inherit from the default margins.

The `columns` option expects a number - the number of columns your body content should have. The default template sets `columns` to `1`.

### Page Numbering

The `page-numbering` option expects a string that describes a [Typst numbering](https://typst.app/docs/reference/model/numbering/) pattern.
For example, the default, `1`, numbers pages with arabic numerals, and `i` numbers pages with lower case roman numerals.
To omit page numbers, set `page-numbering` to `false`:

```yaml
page-numbering: false
```

{{< include /docs/output-formats/_document-options-toc.md >}}

Expand Down
4 changes: 4 additions & 0 deletions docs/reference/formats/typst.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,10 @@
{
"name": "shift-heading-level-by",
"description": "Shift heading levels by a positive or negative integer.\nFor example, with `shift-heading-level-by: -1`, level 2\nheadings become level 1 headings, and level 3 headings\nbecome level 2 headings. Headings cannot have a level\nless than 1, so a heading that would be shifted below level 1\nbecomes a regular paragraph. Exception: with a shift of -N,\na level-N heading at the beginning of the document\nreplaces the metadata title.\n"
},
{
"name": "page-numbering",
"description": "Schema to use for numbering pages, e.g. `1` or `i`, or `false` to omit page numbering.\n\nSee [Typst Numbering](https://typst.app/docs/reference/model/numbering/) \nfor additional information.\n"
}
]
},
Expand Down