{"id":16611731,"url":"https://github.com/myriad-dreamin/shiroa","last_synced_at":"2025-05-16T18:06:55.029Z","repository":{"id":188361849,"uuid":"637040710","full_name":"Myriad-Dreamin/shiroa","owner":"Myriad-Dreamin","description":"shiroa is a simple tool for creating modern online books in pure typst.","archived":false,"fork":false,"pushed_at":"2025-04-24T07:19:19.000Z","size":6269,"stargazers_count":434,"open_issues_count":8,"forks_count":20,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-24T07:38:12.583Z","etag":null,"topics":["cli","typst"],"latest_commit_sha":null,"homepage":"https://myriad-dreamin.github.io/shiroa/","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Myriad-Dreamin.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-05-06T10:19:14.000Z","updated_at":"2025-04-24T07:04:20.000Z","dependencies_parsed_at":"2023-08-15T02:17:25.729Z","dependency_job_id":"badadc8d-4bc0-414b-a9b9-4b1a3523ad30","html_url":"https://github.com/Myriad-Dreamin/shiroa","commit_stats":null,"previous_names":["myriad-dreamin/typst-book","myriad-dreamin/shiroa"],"tags_count":31,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Myriad-Dreamin%2Fshiroa","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Myriad-Dreamin%2Fshiroa/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Myriad-Dreamin%2Fshiroa/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Myriad-Dreamin%2Fshiroa/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Myriad-Dreamin","download_url":"https://codeload.github.com/Myriad-Dreamin/shiroa/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254582905,"owners_count":22095518,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","typst"],"created_at":"2024-10-12T01:39:14.701Z","updated_at":"2025-05-16T18:06:55.009Z","avatar_url":"https://github.com/Myriad-Dreamin.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# shiroa\n\n[_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.\n\n## Installation (shiroa CLI)\n\nThere are multiple ways to install the [shiroa](https://github.com/Myriad-Dreamin/shiroa) CLI tool.\nChoose any one of the methods below that best suit your needs.\n\n### Pre-compiled binaries\n\nExecutable binaries are available for download on the [GitHub Releases page](https://github.com/Myriad-Dreamin/shiroa/releases).\nDownload the binary for your platform (Windows, macOS, or Linux) and extract the archive.\nThe archive contains an `shiroa` executable which you can run to build your books.\n\nTo make it easier to run, put the path to the binary into your `PATH`.\n\n### Build from source using Rust\n\nTo build the `shiroa` executable from source, you will first need to install Yarn, Rust, and Cargo.\nFollow 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).\nshiroa currently requires at least Rust version 1.75.\n\nTo build with precompiled artifacts, run the following commands:\n\n```sh\ncargo install --git https://github.com/Myriad-Dreamin/shiroa --locked shiroa\n```\n\nTo build from source, run the following commands:\n\n```sh\ngit clone https://github.com/Myriad-Dreamin/shiroa.git\ngit submodule update --recursive --init\ncargo run --bin shiroa-build\n# optional: install it globally\ncargo install --path ./cli\n```\n\nWith global installation, to uninstall, run the command `cargo uninstall shiroa`.\n\nAgain, make sure to add the Cargo bin directory to your `PATH`.\n\n### Get started\n\nSee the [Get-started](https://myriad-dreamin.github.io/shiroa/guide/get-started.html) online documentation.\n\n### Setup for writing your book\n\nWe 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):\n\n- via [Official Web App](https://typst.app).\n\n- 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).\n\n- 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).\n\n- via `typst-cli watch`, See [typst-cli watch](https://github.com/typst/typst#usage).\n\n### Acknowledgement\n\n- The [mdbook theme](./themes/mdbook/) is borrowed from [mdBook](https://github.com/rust-lang/mdBook/tree/master/src/theme) project.\n\n- Compile the document with awesome [Typst](https://github.com/typst/typst).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmyriad-dreamin%2Fshiroa","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmyriad-dreamin%2Fshiroa","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmyriad-dreamin%2Fshiroa/lists"}