m

min-book

@preview

Simple and complete books without introducing new syntax

v1.5.1
MIT-0
Template

Package Information

Last Updated
Minimum Typst Version
0.15.0
Categories
layoutbook

Preview

Template preview

1. Get the package

Download the package using the TPIX CLI:

tpix get @preview/min-book:1.5.1

2. Initialize from template

Create a new project from this template:

typst init @preview/min-book:1.5.1

Version History

1.5.10.15.0
8c2c6e4f3b14...
1.5.0
384d9872e317...
1.4.0
c0f9f2f16b0e...
1.3.0
32724dfb9c21...
1.2.1
fa97ceaa43bb...
1.2.0
822c507c4f95...
1.1.0
7188fcb44602...
1.0.0
67e92c52099e...
0.1.1
5c51a4d6476b...
0.1.0
8cf103b5eca2...

Minimal Books

Get Manual
Available Themes
Example PDF
Example source code
Changelog file
Contribute with development

Quick Start

#import "@preview/min-book:1.5.1": book
#show: book.with(
  title: "Book Title",
  subtitle: "Book subtitle",
  authors: "Book Author",
)

= Book Part

== Book Chapter
#lorem(200)

Description

Generate complete and complex books, without any annoying new commands or
syntax, just good old pure Typst. This package manipulates the standard Typst
elements as much as possible, adapting them to the needs of a book structure
in a way that there's no need to learn a whole new semantic just because of
min-book.

For some fancy book features there is no existing compatible Typst element to
re-work and adapt; in those cases, this package do provide additional commands
that are completely optional, for the sake of completeness.

This package comes with some thoughful ready-to-use defaults but also allows
you to play with highly customizable options if you need them, so it's really
up to you: customize it your way or ride along the defaults — both ways are
possible and encouraged.

Feature List

  • Cover
    • Automatic generation
    • Creation using Typst
    • Existing image
  • Title page
    • Automatic generation
    • Creation using Typst
  • Cataloging in Publication
  • Errata
  • Dedication
  • Acknowledgments
  • Epigraph
  • Table of contents
    • Automatic generation
    • Insert manually
  • Book parts (headings)
  • Book chapters (headings)
  • Translations
    • Default translations for several languages
    • Custom translation files
    • Localization using Fluent
  • Themes
    • Stylish (default)
    • Coffee
    • Elegance
    • Custom themes
  • Draft mode
    • Comments
    • Text highlight
    • Event timeline
    • Book scenes
  • Advanced customization options
  • Free default fonts
  • End Notes
  • Horizontal Rule
  • Block Quote
  • Appendices ambient
  • Annexes ambient

Default Fonts

Each theme may require a different set of default fonts to function correctly.
The fonts required by the built-in themes can be found in docs/themes.md.

For third-party themes, please refer to their documentation.