Home

Awesome

shiroa

shiroa (Shiro A, or The White, or 云笺) is a simple tool for creating modern online (cloud) books in pure typst.

Installation (shiroa CLI)

There are multiple ways to install the shiroa CLI tool. Choose any one of the methods below that best suit your needs.

Pre-compiled binaries

Executable binaries are available for download on the GitHub Releases page. Download the binary for your platform (Windows, macOS, or Linux) and extract the archive. The archive contains an shiroa executable which you can run to build your books.

To make it easier to run, put the path to the binary into your PATH.

Build from source using Rust

To build the shiroa executable from source, you will first need to install Yarn, Rust, and Cargo. Follow the instructions on the Yarn installation page and Rust installation page. shiroa currently requires at least Rust version 1.75.

To build with precompiled artifacts, run the following commands:

cargo install --git https://github.com/Myriad-Dreamin/shiroa --locked shiroa-cli

To build from source, run the following commands:

git clone https://github.com/Myriad-Dreamin/shiroa.git
git submodule update --recursive --init
cargo run --bin shiroa-build
# optional: install it globally
cargo install --path ./cli

With global installation, to uninstall, run the command cargo uninstall shiroa.

Again, make sure to add the Cargo bin directory to your PATH.

Get started

See the Get-started online documentation.

Setup for writing your book

We don't provide a watch command, but shiroa is designated to embracing all of the approaches to writing typst documents. It's feasible to preview your documents by following approaches (like previewing normal documents):

Acknowledgement