https://github.com/jomaway/typst-gentle-clues

Simple admonishment for typst
https://github.com/jomaway/typst-gentle-clues

Last synced: 6 days ago
JSON representation

Simple admonishment for typst

• Host: GitHub
• URL: https://github.com/jomaway/typst-gentle-clues
• Owner: jomaway
• License: mit
• Created: 2023-08-14T10:24:30.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-27T21:48:51.000Z (12 days ago)
• Last Synced: 2024-10-28T01:48:57.875Z (12 days ago)
• Language: Typst
• Size: 10.4 MB
• Stars: 48
• Watchers: 2
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-typst - typst-gentle-clues - A typst package to simply add admonitions. (Templates & Libraries / Formatting)

README

        
# gentle-clues

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

Inspired from [mdbook-admonish](https://tommilligan.github.io/mdbook-admonish/).

## Overview of all predefined clues:

![Overview of the predefined clues](./gc-overview.svg)

## Usage

For full information, see the [docs.pdf](https://github.com/jomaway/typst-gentle-clues/blob/main/docs.pdf)

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

```typst

#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](https://github.com/jomaway/typst-gentle-clues/blob/main/docs.pdf).

## Language support

This package does use [linguify](https://github.com/jomaway/typst-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](https://github.com/jomaway/typst-gentle-clues/blob/main/lib/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](LICENSE)

## Changelog

[See CHANGELOG.md](CHANGELOG.md)