Skip to content

jomaway/typst-gentle-clues

Repository files navigation

gentle-clues

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

Inspired from mdbook-admonish.

Overview of all predefined clues:

Overview of the predefined clues

Usage

For full information, see the docs.pdf

To use this package, simply add the following code to your document:

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

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

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

_This will create an info clue and tip clue inside your document. See the overview for all available clues.

Features

This package provides some features which helps to customize the clues to your liking.

  • Set global default for all clues
  • Overwrite each parameter on a single clue for changing title, color, etc.
  • Show or hide a counter value on tasks.
  • Define your own clues very easily.
  • ...

For a full list see the documentation.

Language support

This package does use linguify to support multiple languages.

Header titles: The language of the header titles is detected automatically from the context text.lang. See the file lang.toml for currently supported languages.

If an unsupported language is set it will fallback to english as default. Feel free to open a PR with your language added to the lang.toml file.

License

MIT License

Changelog

See CHANGELOG.md