Hey there!\n\nHere are two paragraphs. The\noutput is shown to the right.\n![\"Preview\"](\"/en-US-v0.14.1/assets/d576b17fe173f96eda81c5ea2a62f28d.png\")
This page is a good starting point if you have used LaTeX before and want to try\nout Typst. We will explore the main differences between these two systems from a\nuser perspective. Although Typst is not built upon LaTeX and has a different\nsyntax, you will learn how to use your LaTeX skills to get a head start.
\nJust like LaTeX, Typst is a markup-based typesetting system: You compose your\ndocument in a text file and mark it up with commands and other syntax. Then, you\nuse a compiler to typeset the source file into a PDF. However, Typst also\ndiffers from LaTeX in several aspects: For one, Typst uses more dedicated syntax\n(like you may know from Markdown) for common tasks. Typst's commands are also\nmore principled: They all work the same, so unlike in LaTeX, you just need to\nunderstand a few general concepts instead of learning different conventions for\neach package. Moreover Typst compiles faster than LaTeX: Compilation usually\ntakes milliseconds, not seconds, so the web app and the compiler can both\nprovide instant previews.
\nIn the following, we will cover some of the most common questions a user\nswitching from LaTeX will have when composing a document in Typst. If you prefer\na step-by-step introduction to Typst, check out our tutorial.
\nYou have two ways to use Typst: In our web app or\nby installing the compiler on your\ncomputer. When you use the web app, we provide a batteries-included\ncollaborative editor and run Typst in your browser, no installation required.
\nIf you choose to use Typst on your computer instead, you can download the\ncompiler as a single, small binary which any user can run, no root privileges\nrequired. Unlike popular LaTeX distributions such as TeX Live, packages are\ndownloaded when you first use them and then cached locally, keeping your Typst\ninstallation lean. You can use your own editor and decide where to store your\nfiles with the local compiler.
\nThat's easy. You just create a new, empty text file (the file extension is\n.typ). No boilerplate is needed to get started. Simply start by writing your\ntext. It will be set on an empty A4-sized page. If you are using the web app,\nclick "+ Empty document" to create a new project with a file and enter the\neditor. Paragraph breaks work just as they do in LaTeX, just use a\nblank line.
Hey there!\n\nHere are two paragraphs. The\noutput is shown to the right.\nIf you want to start from an preexisting LaTeX document instead, you can use\nPandoc to convert your source code to Typst markup. This\nconversion is also built into our web app, so you can upload your .tex file to\nstart your project in Typst.
LaTeX uses the command \\section to create a section heading. Nested headings\nare indicated with \\subsection, \\subsubsection, etc. Depending on your\ndocument class, there is also \\part or \\chapter.
In Typst, headings are less verbose: You prefix the line with the\nheading on it with an equals sign and a space to get a first-order heading:\n= Introduction. If you need a second-order heading, you use two equals\nsigns: == In this paper. You can nest headings as deeply as you'd like by\nadding more equals signs.
Emphasis (usually rendered as italic text) is expressed by enclosing text in\n_underscores_ and strong emphasis (usually rendered in boldface) by using\n*stars* instead.
Here is a list of common markup commands used in LaTeX and their Typst\nequivalents. You can also check out the full syntax cheat sheet.
\n| Element | LaTeX | Typst | See |
|---|---|---|---|
| Strong emphasis | \\textbf{strong} | *strong* | strong |
| Emphasis | \\emph{emphasis} | _emphasis_ | emph |
| Link | \\url{https://typst.app} | https://typst.app/ | link |
| Label | \\label{intro} | <intro> | label |
| Reference | \\ref{intro} | @intro | ref |
| Citation | \\cite{humphrey97} | @humphrey97 | cite |
| Monospace (typewriter) | \\texttt{mono} | text or mono functions | text, mono |
| Code | lstlisting environment | `print(f"{x}")` | raw |
| Verbatim | verbatim environment | `#typst-code()` | raw |
| Bullet list | itemize environment | - List | list |
| Numbered list | enumerate environment | + List | enum |
| Term list | description environment | / Term: List | terms |
| Figure | figure environment | figure function | figure |
| Table | table environment | table function | table |
| Equation | $x$, align / equation environments | $x$, $ x = y $ | equation |
Lists do not rely on environments in Typst. Instead, they have\nlightweight syntax like headings. To create an unordered list (itemize),\nprefix each line of an item with a hyphen:
To write this list in Typst...\n\n```latex\n\\begin{itemize}\n \\item Fast\n \\item Flexible\n \\item Intuitive\n\\end{itemize}\n```\n\n...just type this:\n\n- Fast\n- Flexible\n- Intuitive\n\n![\"Preview\"](\"/en-US-v0.14.1/assets/12dc490699b39fe43771a51e9bcf6639.png\")
Nesting lists works just by using proper indentation. Adding a blank line in\nbetween items results in a more widely spaced list.
\nTo get a numbered list (enumerate) instead, use a + instead of the\nhyphen. For a term list (description), write / Term: Description\ninstead.
Note that the raw function and syntax (e.g. `raw`) only work for\nverbatim (unformatted) text. If you require formatting, you can use the\ntext function with a monospace font instead, like in the example\nbelow:
#text(\n font: "DejaVu Sans Mono",\n size: 0.8em,\n)[monospace *bold*]\n![\"Preview\"](\"/en-US-v0.14.1/assets/1c8b7b315c9a9231ec2f8ee31b5cc24.png\")
LaTeX heavily relies on commands (prefixed by backslashes). It uses these\nmacros to affect the typesetting process and to insert and manipulate content.\nSome commands accept arguments, which are most frequently enclosed in curly\nbraces: \\cite{rasmus}.
Typst differentiates between markup mode and code mode.\nThe default is markup mode, where you compose text and apply syntactic\nconstructs such as *stars for bold text*. Code mode, on the other hand,\nparallels programming languages like Python, providing the option to input and\nexecute segments of code.
Within Typst's markup, you can switch to code mode for a single command (or\nrather, expression) using a hash (#). This is how you call functions to, for\nexample, split your project into different files or\nrender text based on some condition. Within code\nmode, it is possible to include normal markup content by using\nsquare brackets. Within code mode, this content is treated just as any other\nnormal value for a variable.
First, a rectangle:\n#rect()\n\nLet me show how to do\n#underline([_underlined_ text])\n\nWe can also do some maths:\n#calc.max(3, 2 * 4)\n\nAnd finally a little loop:\n#for x in range(3) [\n Hi #x.\n]\n![\"Preview\"](\"/en-US-v0.14.1/assets/61187e014908ab80b5988f03553820b3.png\")
A function call always involves the name of the function (rect,\nunderline, calc.max, range) followed by\nparentheses (as opposed to LaTeX where the square brackets and curly braces are\noptional if the macro requires no arguments). The expected list of arguments\npassed within those parentheses depends on the concrete function and is\nspecified in the reference.
A function can have multiple arguments. Some arguments are positional, i.e., you\njust provide the value: The function #lower("SCREAM") returns its argument\nin all-lowercase. Many functions use named arguments instead of positional\narguments to increase legibility. For example, the dimensions and stroke of a\nrectangle are defined with named arguments:
#rect(\n width: 2cm,\n height: 1cm,\n stroke: red,\n)\n![\"Preview\"](\"/en-US-v0.14.1/assets/aa17a54d4d9e1338642f4ce9fff72220.png\")
You specify a named argument by first entering its name (above, it's width,\nheight, and stroke), then a colon, followed by the value (2cm, 1cm,\nred). You can find the available named arguments in the reference\npage for each function or in the autocomplete panel when typing.\nNamed arguments are similar to how some LaTeX environments are configured, for\nexample, you would type \\begin{enumerate}[label={\\alph*)}] to start a list\nwith the labels a), b), and so on.
Often, you want to provide some content to a function. For example, the LaTeX\ncommand \\underline{Alternative A} would translate to\n#underline([Alternative A]) in Typst. The square brackets indicate that a\nvalue is content. Within these brackets, you can use normal markup.\nHowever, that's a lot of parentheses for a pretty simple construct. This is why\nyou can also move trailing content arguments after the parentheses (and omit the\nparentheses if they would end up empty).
Typst is an #underline[alternative]\nto LaTeX.\n\n#rect(fill: aqua)[Get started here!]\n![\"Preview\"](\"/en-US-v0.14.1/assets/997bfedfa9b70b688ba2c04b2313231f.png\")
You likely already noticed that the arguments have distinctive data types. Typst\nsupports many data types. Below, there is a table with some of the most\nimportant ones and how to write them. In order to specify values of any of these\ntypes, you have to be in code mode!
\n| Data type | Example |
|---|---|
| Content | [*fast* typesetting] |
| String | "Pietro S. Author" |
| Integer | 23 |
| Floating point number | 1.459 |
| Absolute length | 12pt, 5in, 0.3cm, ... |
| Relative length | 65% |
The difference between content and string is that content can contain markup,\nincluding function calls, while a string really is just a plain sequence of\ncharacters.
\nTypst provides control flow constructs and\noperators such as + for adding things or == for\nchecking equality between two variables.
You can also store values, including functions, in your own\nvariables. This can be useful to perform computations on\nthem, create reusable automations, or reference a value multiple times. The\nvariable binding is accomplished with the let keyword, which works similar to\n\\newcommand:
// Store the integer `5`.\n#let five = 5\n\n// Define a function that\n// increments a value.\n#let inc(i) = i + 1\n\n// Reference the variables.\nI have #five fingers.\n\nIf I had one more, I'd have\n#inc(five) fingers. Whoa!\n![\"Preview\"](\"/en-US-v0.14.1/assets/74df77f136dbc2c18c9af4c5f847ac7.png\")
In LaTeX, some commands like \\textbf{bold text} receive an argument in curly\nbraces and only affect that argument. Other commands such as \\bfseries bold text act as switches (LaTeX calls this a declaration), altering the appearance\nof all subsequent content within the document or current scope.
In Typst, the same function can be used both to affect the appearance for the\nremainder of the document, a block (or scope), or just its arguments. For\nexample, #text(weight: "bold")[bold text] will only embolden its argument,\nwhile #set text(weight: "bold") will embolden any text until the end of the\ncurrent block, or the end of the document, if there is none. The effects of a\nfunction are immediately obvious based on whether it is used in a call or a\nset rule.
I am starting out with small text.\n\n#set text(14pt)\n\nThis is a bit #text(18pt)[larger,]\ndon't you think?\n![\"Preview\"](\"/en-US-v0.14.1/assets/697fb062ab8493b7a41dd016706677fb.png\")
Set rules may appear anywhere in the document. They can be thought of as\ndefault argument values of their respective function:
\n#set enum(numbering: "I.")\n\nGood results can only be obtained by\n+ following best practices\n+ being aware of current results\n of other researchers\n+ checking the data for biases\n![\"Preview\"](\"/en-US-v0.14.1/assets/153ce40293ed8439477687e95828e77f.png\")
The + is syntactic sugar (think of it as an abbreviation) for a call to the\nenum function, to which we apply a set rule above.\nMost syntax is linked to a function in this way. If you need to style\nan element beyond what its arguments enable, you can completely redefine its\nappearance with a show rule (somewhat comparable to\n\\renewcommand).
You can achieve the effects of LaTeX commands like \\textbf, \\textsf,\n\\rmfamily, \\mdseries, and \\itshape with the font,\nstyle, and weight arguments of the text\nfunction. The text function can be used in a set rule (declaration style) or\nwith a content argument. To replace \\textsc, you can use the smallcaps\nfunction, which renders its content argument as smallcaps. Should you want to\nuse it declaration style (like \\scshape), you can use an\neverything show rule that applies the function to the\nrest of the scope:
#show: smallcaps\n\nBoisterous Accusations\n![\"Preview\"](\"/en-US-v0.14.1/assets/b8a51164b74a742d89b2c318c55936b1.png\")
In LaTeX, you start your main .tex file with the \\documentclass{article}\ncommand to define how your document is supposed to look. In that command, you\nmay have replaced article with another value such as report and amsart to\nselect a different look.
When using Typst, you style your documents with functions.\nTypically, you use a template that provides a function that styles your whole\ndocument. First, you import the function from a template file. Then, you apply\nit to your whole document. This is accomplished with a\nshow rule that wraps the following document in a given\nfunction. The following example illustrates how it works:
\n#import "conf.typ": conf\n#show: conf.with(\n title: [\n Towards Improved Modelling\n ],\n authors: (\n (\n name: "Theresa Tungsten",\n affiliation: "Artos Institute",\n email: "tung@artos.edu",\n ),\n (\n name: "Eugene Deklan",\n affiliation: "Honduras State",\n email: "e.deklan@hstate.hn",\n ),\n ),\n abstract: lorem(80),\n)\n\nLet's get started writing this\narticle by putting insightful\nparagraphs right here!\n![\"Preview\"](\"/en-US-v0.14.1/assets/938ed1adbadc6f39a4ce5faec4677570.png\")
The import statement makes functions\n(and other definitions) from another file available. In this example, it imports\nthe conf function from the conf.typ file. This function formats a document\nas a conference article. We use a show rule to apply it to the document and also\nconfigure some metadata of the article. After applying the show rule, we can\nstart writing our article right away!
You can also use templates from Typst Universe (which is Typst's equivalent of\nCTAN) using an import statement like this: #import "@preview/elsearticle:0.2.1": elsearticle. Check the documentation of an\nindividual template to learn the name of its template function. Templates and\npackages from Typst Universe are automatically downloaded when you first use\nthem.
In the web app, you can choose to create a project from a template on Typst\nUniverse or even create your own using the template wizard. Locally, you can use\nthe typst init CLI to create a new project from a template. Check out the\nlist of templates published on Typst\nUniverse. You can also take a look at the awesome-typst\nrepository to find community templates\nthat aren't available through Universe.
You can also create your own, custom templates.\nThey are shorter and more readable than the corresponding LaTeX .sty files by\norders of magnitude, so give it a try!
Functions are Typst's "commands" and can transform their arguments to an output\nvalue, including document content. Functions are "pure", which means that they\ncannot have any effects beyond creating an output value / output content. This\nis in stark contrast to LaTeX macros that can have arbitrary effects on your\ndocument.
\nTo let a function style your whole document, the show rule processes everything\nthat comes after it and calls the function specified after the colon with the\nresult as an argument. The .with part is a method that takes the conf\nfunction and pre-configures some of its arguments before passing it on to the\nshow rule.
Typst is "batteries included," so the equivalent of many popular LaTeX packages\nis built right-in. Below, we compiled a table with frequently loaded packages\nand their corresponding Typst functions.
\n| LaTeX Package | Typst Alternative |
|---|---|
| graphicx, svg | image function |
| tabularx, tabularray | table, grid functions |
| fontenc, inputenc, unicode-math | Just start writing! |
| babel, polyglossia | text function: #set text(lang: "zh") |
| amsmath | Math mode |
| amsfonts, amssymb | sym module and syntax |
| geometry, fancyhdr | page function |
| xcolor | text function: #set text(fill: rgb("#0178A4")) |
| hyperref | link function |
| bibtex, biblatex, natbib | cite, bibliography functions |
| lstlisting, minted | raw function and syntax |
| parskip | block and par functions |
| csquotes | Set the text language and type " or ' |
| caption | figure function |
| enumitem | list, enum, terms functions |
| nicefrac | frac.style property |
Although many things are built-in, not everything can be. That's why Typst has\nits own package ecosystem where the community share its creations\nand automations. Let's take, for instance, the CeTZ package: This package\nallows you to create complex drawings and plots. To use CeTZ in your document,\nyou can just write:
\n#import "@preview/cetz:0.4.1"\n(The @preview is a namespace that is used while the package manager is still\nin its early and experimental state. It will be replaced in the future.)
Aside from the official package hub, you might also want to check out the\nawesome-typst repository, which\ncompiles a curated list of resources created for Typst.
\nIf you need to load functions and variables from another file within your\nproject, for example to use a template, you can use the same\nimport statement with a file name rather than a\npackage specification. To instead include the textual content of another file,\nyou can use an include statement. It will retrieve\nthe content of the specified file and put it in your document.
To enter math mode in Typst, just enclose your equation in dollar signs. You can\nenter display mode by adding spaces or newlines between the equation's contents\nand its enclosing dollar signs.
\nThe sum of the numbers from\n$1$ to $n$ is:\n\n$ sum_(k=1)^n k = (n(n+1))/2 $\n![\"Preview\"](\"/en-US-v0.14.1/assets/fdc410cc7972bde4bafc1a195e7cf341.png\")
Math mode works differently than regular markup or code mode.\nNumbers and single characters are displayed verbatim, while multiple consecutive\n(non-number) characters will be interpreted as Typst variables.
\nTypst pre-defines a lot of useful variables in math mode. All Greek (alpha,\nbeta, ...) and some Hebrew letters (alef, bet, ...) are available through\ntheir name. Some symbols are additionally available through shorthands, such as\n<=, >=, and ->.
Refer to the symbol pages for a full list of the symbols.\nIf a symbol is missing, you can also access it through a\nUnicode escape sequence.
\nAlternate and related forms of symbols can often be selected by\nappending a modifier after a period. For example,\narrow.l.squiggly inserts a squiggly left-pointing arrow. If you want to insert\nmultiletter text in your expression instead, enclose it in double quotes:
$ delta "if" x <= 5 $\n![\"Preview\"](\"/en-US-v0.14.1/assets/8e4d6c1b9942b3e650facda75cd4db4f.png\")
In Typst, delimiters will scale automatically for their expressions, just as if\n\\left and \\right commands were implicitly inserted in LaTeX. You can\ncustomize delimiter behaviour using the lr function. To\nprevent a pair of delimiters from scaling, you can escape them with backslashes.
Typst will automatically set terms around a slash / as a fraction while\nhonoring operator precedence. All round parentheses not made redundant by the\nfraction will appear in the output.
$ f(x) = (x + 1) / x $\n![\"Preview\"](\"/en-US-v0.14.1/assets/856a459b559bdc89f7dac4bf484207be.png\")
Sub- and superscripts work similarly in Typst and LaTeX.\n$x^2$ will produce a superscript, $x_2$ yields a subscript. If you want\nto include more than one value in a sub- or superscript, enclose their contents\nin parentheses: $x_(a -> epsilon)$.
Since variables in math mode do not need to be prepended with a # (or a \\\nlike in LaTeX), you can also call functions without these special characters:
$ f(x, y) := cases(\n 1 "if" (x dot y)/2 <= 0,\n 2 "if" x "is even",\n 3 "if" x in NN,\n 4 "else",\n) $\n![\"Preview\"](\"/en-US-v0.14.1/assets/d17d4014f0e278177d8e26b02a9734f8.png\")
The above example uses the cases function to describe f. Within\nthe cases function, arguments are delimited using commas and the arguments are\nalso interpreted as math. If you need to interpret arguments as Typst\nvalues instead, prefix them with a #:
$ (a + b)^2\n = a^2\n + text(fill: #maroon, 2 a b)\n + b^2 $\n![\"Preview\"](\"/en-US-v0.14.1/assets/5a6c74c1c15e1b29279ef445bfc6c8e5.png\")
You can use all Typst functions within math mode and insert any content. If you\nwant them to work normally, with code mode in the argument list, you can prefix\ntheir call with a #. Nobody can stop you from using rectangles or emoji as\nyour variables anymore:
$ sum^10_(🤓=1)\n #rect(width: 4mm, height: 2mm)/🤓\n = 🧠maltese $\n![\"Preview\"](\"/en-US-v0.14.1/assets/1f4eb28a5c2927fe2ba512666ced7169.png\")
If you'd like to enter your mathematical symbols directly as Unicode, that is\npossible, too!
\nMath calls can have two-dimensional argument lists using ; as a delimiter. The\nmost common use for this is the mat function that creates\nmatrices:
$ mat(\n 1, 2, ..., 10;\n 2, 2, ..., 10;\n dots.v, dots.v, dots.down, dots.v;\n 10, 10, ..., 10;\n) $\n![\"Preview\"](\"/en-US-v0.14.1/assets/ca24a2958190d70441a482b738ddf8f4.png\")
Papers set in LaTeX have an unmistakeable look. This is mostly due to their\nfont, Computer Modern, justification, narrow line spacing, and wide margins.
\nThe example below
\n#set page(margin: 1.75in)\n#set par(leading: 0.55em, spacing: 0.55em, first-line-indent: 1.8em, justify: true)\n#set text(font: "New Computer Modern")\n#show raw: set text(font: "New Computer Modern Mono")\n#show heading: set block(above: 1.4em, below: 1em)\nThis should be a good starting point! If you want to go further, why not create\na reusable template?
\nTypst includes a fully-featured bibliography system that is compatible with\nBibTeX files. You can continue to use your .bib literature libraries by\nloading them with the bibliography function. Another possibility is to use\nTypst's YAML-based native format.
Typst uses the Citation Style Language to define and process citation and\nbibliography styles. You can compare CSL files to BibLaTeX's .bbx files.\nThe compiler already includes over 80 citation styles,\nbut you can use any CSL-compliant style from the\nCSL repository or write\nyour own.
You can cite an entry in your bibliography or reference a label in your document\nwith the same syntax: @key (this would reference an entry called key).\nAlternatively, you can use the cite function.
Alternative forms for your citation, such as year only and citations for natural\nuse in prose (cf. \\citet and \\textcite) are available with\n#cite(<key>, form: "prose").
You can find more information on the documentation page of the bibliography\nfunction.
Although Typst can be a LaTeX replacement for many today, there are still\nfeatures that Typst does not (yet) support. Here is a list of them which, where\napplicable, contains possible workarounds.
\nWell-established plotting ecosystem. LaTeX users often create elaborate\ncharts along with their documents in PGF/TikZ. The Typst ecosystem does not\nyet offer the same breadth of available options, but the ecosystem around the\ncetz package is catching up\nquickly.
Change page margins without a pagebreak. In LaTeX, margins can always be\nadjusted, even without a pagebreak. To change margins in Typst, you use the\npage function which will force a page break. If you just want a few\nparagraphs to stretch into the margins, then reverting to the old margins, you\ncan use the pad function with negative padding.