Skip to content

Latest commit

 

History

History
78 lines (54 loc) · 1.52 KB

README.md

File metadata and controls

78 lines (54 loc) · 1.52 KB
Raw

GitHub Admonition for Typst

Note

Add GitHub style admonitions (also known as alerts) to Typst.

Usage

Import this package, and do

= Basic Examples

#note[
  Highlights information that users should take into account, even when skimming.
]

#tip[
  Optional information to help a user be more successful.
]

#important[
  Crucial information necessary for users to succeed.
]

#warning[
  Critical content demanding immediate user attention due to potential risks.
]

#caution[
  Negative potential consequences of an action.
]

#admonition(
  icon: "icons/stop.svg",
  color: color.fuchsia,
  title: "Customize",
  foreground-color: color.white,
  background-color: color.black,
)[
  The icon, (theme) color, title, foreground and background color are customizable.
]

= More Examples

#todo[
  Fix `note-me` package.
]

github-admonition

Further Reading:

Style

It borrows the style of GitHub's admonition.

Note

Highlights information that users should take into account, even when skimming.

Tip

Optional information to help a user be more successful.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Caution

Negative potential consequences of an action.

Credits

The admonition icons are from Octicons.