Skip to content

Commit

Permalink
Fix documentation build
Browse files Browse the repository at this point in the history
  • Loading branch information
jakobjpeters committed Oct 20, 2024
1 parent 0346a59 commit ff6cd11
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 9 deletions.
3 changes: 2 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@

## v0.4.0

- Support Typst version 0.12

### Bug Fixes

- If a `TypstString` contains any characters that satisfy `!isprint`,
`show(::IO, ::TypstString)` now prints a format that preserves those characters.
- Delete redundant `show_typst` documentation for `String`
- Account for a [Typst bug with single-letter strings in `math` mode](https://github.com/typst/typst/issues/274#issue-1639854848)
15 changes: 8 additions & 7 deletions docs/source/tutorials/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,18 +40,19 @@ typst"$ π approx 3.141592653589793 $"

## Commands

Easily generate a Typst source file and compile it into a document using [`render`](@ref).

```jldoctest 1
julia> render(Any[true 1; 1.2 1 // 2]);
```

Use the Typst command-line interface by [`run`](@ref)ning a
[`TypstCommand`](@ref) created with its constructor or [`@typst_cmd`](@ref).

```jldoctest 1
julia> TypstCommand(["help"])
typst`help`
julia> run(typst`compile input.typ output.pdf`);
julia> typst`compile input.typ output.pdf`
typst`compile input.typ output.pdf`
```

Easily generate a Typst source file and compile it into a document using [`render`](@ref).

```jldoctest 1
julia> render(Any[true 1; 1.2 1 // 2]);
```
2 changes: 1 addition & 1 deletion src/Commands.jl
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ const preamble = typst"""
input = "input.typ",
output = "output.pdf",
open = true,
preamble = Typstry.preamble,
preamble = preamble,
context...)
Render to a document using
Expand Down

0 comments on commit ff6cd11

Please sign in to comment.