Note
Add GitHub style admonitions (also known as alerts) to Typst.
Import this package, and do
// Import from @preview namespace is suggested
// #import "@preview/note-me:0.3.0": *
// Import from @local namespace is only for debugging purpose
// #import "@local/note-me:0.3.0": *
// Import relatively is for development purpose
#import "lib.typ": *
= 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-path: "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.
]
#admonition(
icon-string: read("icons/light-bulb.svg"),
color: color.fuchsia,
title: "Customize",
)[
The icon can be specified as a string of SVG. This is useful if the user want to use an SVG icon that is not available in this package.
]
#admonition(
icon: [🙈],
color: color.fuchsia,
title: "Customize",
)[
Or, pass a content directly as the icon...
]
= More Examples
#todo[
Fix `note-me` package.
]
= Prevent Page Breaks from Breaking Admonitions
#box(
width: 1fr,
height: 50pt,
fill: gray,
)
#note[
#lorem(100)
]
Further Reading:
- https://github.com/orgs/community/discussions/16925
- https://docs.asciidoctor.org/asciidoc/latest/blocks/admonitions/
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.
The admonition icons are from Octicons.