diff options
| author | Laurenz <laurmaedje@gmail.com> | 2023-02-06 11:50:03 +0100 |
|---|---|---|
| committer | Laurenz <laurmaedje@gmail.com> | 2023-02-06 11:50:03 +0100 |
| commit | 0bb0f1c98fc8eff5d7556bbe9d5801f02237a5c0 (patch) | |
| tree | 83bce472d527cb62c6b6d048059921d8404074fd /docs/src/reference/welcome.md | |
| parent | 2e87dcdbe014a5327395cfcd138b547426a50e6e (diff) | |
Import documentation
Co-Authored-By: Martin Haug <mhaug@live.de>
Diffstat (limited to 'docs/src/reference/welcome.md')
| -rw-r--r-- | docs/src/reference/welcome.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/src/reference/welcome.md b/docs/src/reference/welcome.md new file mode 100644 index 00000000..dc38663d --- /dev/null +++ b/docs/src/reference/welcome.md @@ -0,0 +1,29 @@ +--- +description: | + The Typst reference is a systematic and comprehensive guide to the Typst + typesetting language. +--- + +# Reference +This reference documentation is a comprehensive guide to all of Typst's +syntax, concepts, types, and functions. If you are completely new to Typst, we +recommend starting with the [tutorial]($tutorial) and then coming back to +the reference to learn more about Typst's features as you need them. + +## Language +The reference starts with a language part that gives an overview over [Typst's +syntax]($syntax) and contains information about concepts involved in +[styling documents,]($styling) using +[Typst's scripting capabilities,]($scripting) and a detailed documentation of +all [data types]($types) in Typst. + +## Functions +The second part includes chapters on all functions used to insert, style, transform, +and layout content in Typst documents. Each function is documented with a +description of its purpose, a list of its parameters, and examples of how to use +it. + +The final part of the reference explains all functions that are used within +Typst's code mode to manipulate and transform data. Just as in the previous +part, each function is documented with a description of its purpose, a list of +its parameters, and examples of how to use it. |
