konevsa/typst
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated README.md for new CLI (#471)

Browse Source
This commit is contained in:
Sébastien d'Herbais de Thun 2023-04-05 00:58:01 +02:00 committed by GitHub
parent 72c7c04a9d
commit 205b9f3f25
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -123,10 +123,10 @@ the bleeding edge version with `nix run github:typst/typst -- --version`.
Once you have installed Typst, you can use it like this:
```sh
# Creates `file.pdf` in working directory.
typst file.typ
typst compile file.typ
# Creates PDF file at the desired path.
typst path/to/source.typ path/to/output.pdf
typst compile path/to/source.typ path/to/output.pdf
```
You can also watch source files and automatically recompile on changes. This is
@ -134,7 +134,16 @@ faster than compiling from scratch each time because Typst has incremental
compilation.
```sh
# Watches source files and recompiles on changes.
typst --watch file.typ
typst watch file.typ
```
You can also add custom font paths for your project and list all of the discovered fonts:
```sh
# Adds additional directories to search for fonts.
typst --font-path path/to/fonts compile file.typ
# Lists all of the discovered fonts.
typst --font-path path/to/fonts fonts
```
If you prefer an integrated IDE-like experience with autocompletion and instant