https://github.com/shadowmitia/typst-babble-bubbles

A package to create callouts in typst
https://github.com/shadowmitia/typst-babble-bubbles

typst typst-package

Last synced: about 1 month ago
JSON representation

A package to create callouts in typst

• Host: GitHub
• URL: https://github.com/shadowmitia/typst-babble-bubbles
• Owner: ShadowMitia
• License: mit
• Created: 2023-09-10T20:17:59.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-08T20:49:45.000Z (about 1 month ago)
• Last Synced: 2024-11-08T21:33:40.375Z (about 1 month ago)
• Topics: typst, typst-package
• Language: Typst
• Homepage:
• Size: 76.2 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# typst-babble-bubbles

A package to create callouts in typst, inspired by the [Obsidan](https://obsidian.md/) callouts.

Use preset callouts, or create your own!

![callouts_example](examples/callouts.png)

## Usage

Import the package

```typst

#import "@preview/babble-bubbles:0.1.0": *

```

Or grab it locally and use:

```typst

#import "@local/babble-bubbles:0.1.0": *

```

## Presets

Here you can find a list of presets and an example usage of each.

You can customise them with the same parameters as the `callout` function. See the `Custom callouts` for more details.

```typst

#info[This is information]

#success[I'm making a note here: huge success]

#check[This is checked!]

#warning[First warning...]

#note[My incredibly useful note]

#question[Question?]

#example[An example make things interesting]

#quote[To be or not to be]

```

## Custom callouts

### `callout`

Create a default callout.

Tweak the parameters to create your own!

```typst

callout(

  body,

  title: "Callout",

  fill: blue,

  title-color: white,

  body-color: black,

  icon: none)

```

### Tips

You can create aliases to more easily handle your

newly create callouts or customise presets by using [with](https://typst.app/docs/reference/foundations/function/#definitions-with).

```

#let mycallout = callout.with(title: "My callout")

#mycallout[Hey this is my custom callout!]

```