Universe

Create project in app

Manual Example PDF Example SRC Changelog Contribute

Quick Start

#import "@preview/min-manual:0.3.0": manual
#show: manual.with(
  title: "Package Name",
  manifest: toml("typst.toml"),
)

Description

Create modern and elegant manuals with a clean visual style and a focus on maintaining attention on the document’s content. This package seeks a balance between new visual trends and the traditional simplicity of older manuals: there are no abstract designs, colorful sections, diverse themes, or anything that steals the focus; however, it adopts modern fonts, pleasant spacing, text layout inspired by web pages, as well as automation tools and practical features.

This was created with Typst in mind, but also aiming for the potential to universally document code from other languages: all the features of min-book are supported when documenting any type of program or code.

Feature List

  • Universal documentation
    • Typst packages/templates
    • Any other language
  • Retrieval of data from typst.toml package manifest
  • Documentation for arguments/options
  • Extract code snippets from files
  • Showcase code examples and its result
  • Terminal simulation
  • Customizable callout boxes
  • Paper-friendly links (attached to footnotes)
  • Quick repository reference
    • Typst Universe packages
    • PyPi packages
    • Rust crates
    • GitHub repositories
    • Any package URL
  • Documentation retrieval from Markdown files
    • CommonMark Markdown
    • Typst code support
    • Access to min-manual features (Typst mode)
  • Documentation retrieval from source code comments
    • Typst code support
    • Access to min-manual features
    • Special syntax for some min-manual features

Default Fonts

Text: TeX Gyre Heros or Arial

Headings: TeX Gyre Adventor or Century Gothic

Mono: Fira Mono or Inconsolata