{"repo":"Myriad-Dreamin/shiroa","free":true,"listed":false,"github":"https://github.com/Myriad-Dreamin/shiroa","clone":"git clone https://github.com/Myriad-Dreamin/shiroa.git","description":"shiroa is a simple tool for creating modern online books in pure typst.","language":"Typst","stars":659,"topics":["typst","cli"],"license":"Apache-2.0","category":"cli-tools","readme_excerpt":"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 pnpm, Rust, and Cargo. Follow the instructions on the pnpm installation page and Rust installation page. shiroa currently requires at least Rust version 1.75. To build with precompiled artifacts, run the following commands: To build from source, run the following commands: 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): - via Official Web App. - via VSCod(e,ium), see Tinymist and Typst P","default_branch":null,"files":null,"tree":[],"storefront":"/r/Myriad-Dreamin","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Myriad-Dreamin/shiroa/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}