Command Line Tool
The shiroa
shiroa
command-line tool is used to create and build books. After you have installed shiroa
shiroa
, you can run the shiroa help
shiroa help
command in your terminal to view the available commands.
This following sections provide in-depth information on the different commands available.
shiroa init <directory>
shiroa init <directory>
— Creates a new book with minimal boilerplate to start with.shiroa build
shiroa build
— Renders the book.shiroa serve
shiroa serve
— Runs a web server to view the book, and rebuilds on changes.shiroa clean
shiroa clean
— Deletes the rendered output.shiroa completions
shiroa completions
— Support for shell auto-completion.
We suggest you to use Typst Preview plugin for preview feature. For more details, please see Get Started chapter.