diff options
| author | Laurenz <laurmaedje@gmail.com> | 2023-07-02 19:59:52 +0200 |
|---|---|---|
| committer | Laurenz <laurmaedje@gmail.com> | 2023-07-02 20:07:43 +0200 |
| commit | ebfdb1dafa430786db10dad2ef7d5467c1bdbed1 (patch) | |
| tree | 2bbc24ddb4124c4bb14dec0e536129d4de37b056 /docs/tutorial/welcome.md | |
| parent | 3ab19185093d7709f824b95b979060ce125389d8 (diff) | |
Move everything into `crates/` directory
Diffstat (limited to 'docs/tutorial/welcome.md')
| -rw-r--r-- | docs/tutorial/welcome.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/docs/tutorial/welcome.md b/docs/tutorial/welcome.md new file mode 100644 index 00000000..530336cb --- /dev/null +++ b/docs/tutorial/welcome.md @@ -0,0 +1,44 @@ +--- +description: Typst's tutorial. +--- + +# Tutorial +Welcome to Typst's tutorial! In this tutorial, you will learn how to write and +format documents in Typst. We will start with everyday tasks and gradually +introduce more advanced features. This tutorial does not assume prior knowledge +of Typst, other Markup languages, or programming. We do assume that you know how +to edit a text file. + +The best way to start is to sign up to the Typst app for free and follow along +with the steps below. The app gives you instant preview, syntax highlighting and +helpful autocompletions. Alternatively, you can follow along in your local text +editor with the [open-source CLI](https://github.com/typst/typst). + +## When to use Typst { #when-typst } +Before we get started, let's check what Typst is and when to use it. Typst is a +markup language for typesetting documents. It is designed to be easy to learn, +fast, and versatile. Typst takes text files with markup in them and outputs +PDFs. + +Typst is a good choice for writing any long form text such as essays, articles, +scientific papers, books, reports, and homework assignments. Moreover, Typst is +a great fit for any documents containing mathematical notation, such as papers +in the math, physics, and engineering fields. Finally, due to its strong styling +and automation features, it is an excellent choice for any set of documents that +share a common style, such as a book series. + +## What you will learn { #learnings } +This tutorial has four chapters. Each chapter builds on the previous one. Here +is what you will learn in each of them: + +1. [Writing in Typst:]($tutorial/writing-in-typst) Learn how to write text and + insert images, equations, and other elements. +2. [Formatting:]($tutorial/formatting) Learn how to adjust the formatting + of your document, including font size, heading styles, and more. +3. [Advanced Styling:]($tutorial/advanced-styling) Create a complex page + layout for a scientific paper with typographic features such as an author + list and run-in headings. +4. [Making a Template:]($tutorial/making-a-template) Build a reusable template + from the paper you created in the previous chapter. + +We hope you'll enjoy Typst! |
