Universe

Simple admonitions for typst. Add predefined or define your own.

Inspired from mdbook-admonish.

Usage

Import the package

#import "@preview/gentle-clues:0.6.0": *

Change the default settings.

#show: gentle-clues.with(
  lang: "de", // set header title language (default: "en")
)

See the docs.pdf for all options

Use predefined clues

// info clue
#info[ This is the info clue ... ] 

// or a tip
#tip(title: "Best tip ever")[Check out this cool package]

Overview of the predefined clues:

Overview of the predefined clues

abstract, info, question, memo, task, idea, tip, quote, success, warning, error, example.

Define your own clue

But it is very easy to define your own.

//When you import the package, include clue
#import "@preview/gentle-clues:0.5.0": clue

//Define it
#let ghost-admon(..args) = clue(
  title: "Buuuuh", 
  _color: gray,
  icon: emoji.ghost, 
  ..args
)
// Use it
#ghost-admon[Huuuuuh.]

The icon can be an emoji, symbol or .svg-file.

License

MIT License

Changelog

See CHANGELOG.md