caisin/typst
1
0
Fork 0
mirror of https://github.com/typst/typst synced 2025-07-27 22:37:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

Refactor "Writing in Typst" tutorial

Browse Source
This commit is contained in:
Andrew Voynov 2025-06-12 07:36:19 +03:00
parent fea153a6fc
commit 7f24cd9253
No known key found for this signature in database
GPG Key ID: 1BE92DD685700329
1 changed files with 25 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/tutorial/1-writing.md
View File

@ -84,8 +84,9 @@ meaning in Typst. We can use `=`, `-`, `+`, and `_` to create headings, lists
and emphasized text, respectively. However, having a special symbol for and emphasized text, respectively. However, having a special symbol for
everything we want to insert into our document would soon become cryptic and everything we want to insert into our document would soon become cryptic and
unwieldy. For this reason, Typst reserves markup symbols only for the most unwieldy. For this reason, Typst reserves markup symbols only for the most
common things. Everything else is inserted with _functions._ For our image to common things. Everything else is inserted with _functions._ For
show up on the page, we use Typst's [`image`] function. [our image](https://github.com/typst/typst-dev-assets/blob/main/files/images/glacier.jpg)
to show up on the page, we use Typst's [`image`] function.
```example ```example
#image("glacier.jpg") #image("glacier.jpg")
@ -125,19 +126,38 @@ mode. This means, you now have to remove the hash before the image function call
The hash is only needed directly in markup (to disambiguate text from function The hash is only needed directly in markup (to disambiguate text from function
calls). calls).
The caption consists of arbitrary markup. To give markup to a function, we The caption consists of arbitrary markup, and can also be a string. To give
enclose it in square brackets. This construct is called a _content block._ markup to a function, we enclose it in square brackets. This construct is called
a _content block._
```example ```example
#figure( #figure(
image("glacier.jpg", width: 70%), image("glacier.jpg", width: 70%),
caption: [ caption: box[
_Glaciers_ form an important part _Glaciers_ form an important part
of the earth's climate system. of the earth's climate system.
], ],
) )
``` ```
**Be careful** about putting the square brackets by themselves on separate
lines. This will introduce leading and trailing space around inline text inside
the brackets, that is hard to notice. Below are several caption examples: one
with extra undesired space, and 3 correct ones.
```example
#show rect: none
#figure(rect(), caption: [
Caption text
])
#figure(rect(), caption: box[
Caption text
])
#figure(rect(), caption: [Caption
text]) // Many spaces in markup counts as one.
#figure(rect(), caption: "Caption text") // Spaces in strings are displayed verbatim.
```
You continue to write your report and now want to reference the figure. To do You continue to write your report and now want to reference the figure. To do
that, first attach a label to figure. A label uniquely identifies an element in that, first attach a label to figure. A label uniquely identifies an element in
your document. Add one after the figure by enclosing some name in angle your document. Add one after the figure by enclosing some name in angle