Create project in app
Modern but sober manuals inspired by the manpages of old.
Quick Start
#import "@preview/min-manual:0.2.0": manual
#show: manual.with(
title: "Package Name",
description: "Short description, no longer than two lines.",
package: "pkg-name:0.4.2",
authors: "Author <@author>",
license: "MIT",
logo: image("assets/logo.png")
)
Description
Generate modern manuals without losing the simplicity of old manpages. This package draws inspiration from old manuals while adopting the facilities of modern tools, like Markdown and documentation embedded in comments. The design aims to be sober: a minimal informative header, technical text in comfortable fonts and well-formatted code examples.
More Information
Feature List
- Universal documentation
- Typst packages
- Typst templates
- Source code in any other language
#arg
document arguments/parameters#extract
retrieves code from other files or location- Paper-friendly links (attached to footnotes)
#url
for general links#univ
for Typst Universe packages#pip
for Python PyPi packages#crate
for Rust crates#gh
for GitHub repos#pkg
for packages of any source
- Documentation in standalone Typst files
- Documentation in standalone Markdown files (experimental)
- CommonMark Markdown
- Typst code support
- All min-manual features (Typst-only)
- Special HTML syntax for
#arg
- Documentation embedded in source code (comments)
- Typst code support
- All min-manual features
- Special syntax for
#extract
- Special syntax for
#arg
Default Fonts
Text: TeX Gyre Heros or Arial
Headings: TeX Gyre Adventor or Century Gothic
Mono: Fira Mono or Inconsolata