Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Myriad-Dreamin/shiroa
shiroa is a simple tool for creating modern online books in pure typst.
https://github.com/Myriad-Dreamin/shiroa
cli typst
Last synced: 3 months ago
JSON representation
shiroa is a simple tool for creating modern online books in pure typst.
- Host: GitHub
- URL: https://github.com/Myriad-Dreamin/shiroa
- Owner: Myriad-Dreamin
- License: apache-2.0
- Created: 2023-05-06T10:19:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-24T03:08:45.000Z (5 months ago)
- Last Synced: 2024-06-24T04:26:28.864Z (5 months ago)
- Topics: cli, typst
- Language: Rust
- Homepage: https://myriad-dreamin.github.io/shiroa/
- Size: 5.7 MB
- Stars: 189
- Watchers: 4
- Forks: 17
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# shiroa
[_shiroa_](https://github.com/Myriad-Dreamin/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](https://github.com/Myriad-Dreamin/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](https://github.com/Myriad-Dreamin/shiroa/releases).
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](https://classic.yarnpkg.com/en/docs/install) and [Rust installation page](https://www.rust-lang.org/tools/install).
shiroa currently requires at least Rust version 1.75.
To build with precompiled artifacts, run the following commands:
```sh
cargo install --git https://github.com/Myriad-Dreamin/shiroa --locked shiroa-cli
```
To build from source, run the following commands:
```sh
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](https://myriad-dreamin.github.io/shiroa/guide/get-started.html) 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](https://typst.app).
- via VSCod(e,ium), see [Tinymist](https://marketplace.visualstudio.com/items?itemName=myriad-dreamin.tinymist) and [Typst Preview](https://marketplace.visualstudio.com/items?itemName=mgt19937.typst-preview).
- via other editors. For example of neovim, see [typst.vim](https://github.com/kaarmu/typst.vim) and [Typst Preview](https://github.com/Enter-tainer/typst-preview#use-without-vscode).
- via `typst-cli watch`, See [typst-cli watch](https://github.com/typst/typst#usage).
### Acknowledgement
- The [mdbook theme](./themes/mdbook/) is borrowed from [mdBook](https://github.com/rust-lang/mdBook/tree/master/src/theme) project.
- Compile the document with awesome [Typst](https://github.com/typst/typst).