CLI Build Command
The build command is used to render your book:
It will try to parse your book.typbook.typ file to understand the structure and metadata of your book and fetch the corresponding files. Note that chapter files used in book.typbook.typ will be created if they are not present in the source directory.
The buildbuild command can take a directory as an argument to use as the book's root instead of the current working directory.
The --root--root option specifies the root directory for typst source files. It is interpreted relative to current work directory of shiroashiroa process.
For example. When a book is created with the main file book-project1/book.typbook-project1/book.typ, and you want to access a template file with path common/book-template.typcommon/book-template.typ, please build it with following command:
Then you can access the template with the absolute path in typst:
The --font-path--font-path option adds additional directories that are recursively searched for fonts for typst source files. If multiple paths are specified, they are separated by the system's path separator (:: on Unix-like systems and ;; on Windows).
The --dest-dir--dest-dir (-d-d) option allows you to change the output directory for the book. Relative paths are interpreted relative to the book's root directory. If not specified it will default to the value of the build.build-dirbuild.build-dir key in book.tomlbook.toml, or to ./book./book.
When your website's root is not exact serving the book, use --path-to-root--path-to-root to specify the path to the root of the book site. For example, if you own myriad-dreamin.github.iomyriad-dreamin.github.io and have mounted the book to /shiroa//shiroa/, you can access https://myriad-dreamin.github.io/shiroa/cli/main.htmlhttps://myriad-dreamin.github.io/shiroa/cli/main.html to get the generated content of cli/main.typcli/main.typ.
The --mode--mode option allows you to specify the mode of rendering typst document. The default mode is normalnormal.
- (Default)
dynamic-pageddynamic-paged: dynamically render as paged document. - (Experimental)
static-htmlstatic-html: statically render the whole document, the embedded frames are not resizable. - (Todo)
static-html-static-pagedstatic-html-static-paged: statically render html parts as much as possible, and leave frames rendered dynamically.
The dynamically rendering means that some elements will be rendered by a wasm renderer in the browser.