Skip to content

jomaway/typst-gentle-clues

Repository files navigation

gentle-clues

Simple admonitions for typst. Use predefined ones or define your own.

Inspired from mdbook-admonish.

Overview of all predefined clues

Overview of the predefined clues

Usage

For detailed information, see the documentation (PDF).

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

#import "@preview/gentle-clues:1.2.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 and tip clue in your document. See the overview for all available clues.

Features

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

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

For a full list see the documentation (PDF).

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 fall back 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

About

Simple admonishment for typst

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 12