1. Introduction
  3. User Guide
  4. 1. Installation
  5. 2. Get Started
  6. 3. Frequently Asked Questions
  7. 4. Further reading
  9. Reference Guide
  10. 5. Command Line Tool
    1. 5.1. init
    2. 5.2. build
    3. 5.3. serve
    4. 5.4. clean
    5. 5.5. completions
  12. 6. Format
    1. 6.1. book.typ
      1. 6.1.1. Book Metadata
        1. 6.1.1.1. Draft chapter
      3. 6.1.2. Build Metadata
    3. 6.2. Theme
    4. 6.3. Typst Support
      1. 6.3.1. Cross Reference
        1. 6.3.1.1. Cross Reference Sample
      3. 6.3.2. Embed Sanitized HTML Elements
        1. 6.3.2.1. Multimedia components
      5. 6.3.3. Semantic Page Description
    6. 6.4. Rendering Tests
  14. 7. For developers
    1. 7.1. Typst-side APIs
    2. 7.2. shiroa CLI Internals
    3. 7.3. Alternative Backends

shiroa

#

Introduction

shiroa (Shiro A, or The White, or 云笺) is a simple tool for creating modern online (cloud) books in pure typst. It has similar use cases as mdBook, which is ideal for creating product or API documentation, tutorials, course materials or anything that requires a clean, easily navigable and customizable presentation.

shiroa is heavily inspired by mdBook, but it is considered to be more adapted to Typst style, hence no guarantee of compatibility with mdBook. Compared with mdBook, we utilizes typst's advantages to bring a more flexible writing experience, such as scripting and package.

#

Not yet finished project

shiroa still have many items in todolist:

  • User experience, which is transparent to writers:

    • SEO optimization
    • Faster font loading
    • Reducing the size of theme bundle files and compiled svg artifacts
    • Add prev/next buttons
    • initialize a book project interactively

  • Writer experience:

    • Book specific helper functions
    • Customize Favicon

Hence you may meet many problems. We are active to receive questions and bugs in Github Issues and please feel free to open issues. If you'd like to contribute, please consider opening a pull request.

#

License

shiroa source and documentation are released under the Apache License v2.0.

The source and documentation in theme directory in themes/mdbook are released under the Mozilla Public License v2.0.