cyberware/docs/features/callouts.md

96 lines
2.1 KiB
Markdown
Raw Normal View History

2023-07-10 02:32:24 +00:00
---
title: Callouts
2023-08-11 07:31:44 +00:00
tags:
- plugin/transformer
2023-07-10 02:32:24 +00:00
---
2023-08-11 07:31:44 +00:00
Quartz supports the same Admonition-callout syntax as Obsidian.
This includes
- 12 Distinct callout types (each with several aliases)
- Collapsable callouts
```
> [!info] Title
> This is a callout!
```
See [documentation on supported types and syntax here](https://help.obsidian.md/Editing+and+formatting/Callouts).
2023-07-10 02:32:24 +00:00
> [!warning]
2023-07-23 00:27:41 +00:00
> Wondering why callouts may not be showing up even if you have them enabled? You may need to reorder your plugins so that `Plugin.ObsidianFlavoredMarkdown()` is _after_ `Plugin.SyntaxHighlighting()`.
2023-07-10 02:32:24 +00:00
2023-08-11 07:31:44 +00:00
## Customization
- Disable callouts: simply pass `callouts: false` to the plugin: `Plugin.ObsidianFlavoredMarkdown({ callouts: false })`
- Editing icons: `quartz/styles/callouts.scss`
### Add custom callouts
By default, custom callouts are handled by applying the `note` style. To make fancy ones, you have to add these lines to `custom.scss`.
```scss title="quartz/styles/custom.scss"
.callout {
&[data-callout="custom"] {
--color: #customcolor;
--border: #custombordercolor;
--bg: #custombg;
--callout-icon: url("data:image/svg+xml; utf8, <custom formatted svg>"); //SVG icon code
}
}
```
> [!warning]
> Don't forget to ensure that the SVG is URL encoded before putting it in the CSS. You can use tools like [this one](https://yoksel.github.io/url-encoder/) to help you do that.
2023-08-11 07:31:44 +00:00
## Showcase
2023-07-10 02:32:24 +00:00
> [!info]
> Default title
> [!question]+ Can callouts be _nested_?
2023-07-23 00:27:41 +00:00
>
> > [!todo]- Yes!, they can. And collapsed!
2023-07-23 00:27:41 +00:00
> >
> > > [!example] You can even use multiple layers of nesting.
2023-07-10 02:32:24 +00:00
> [!note]
> Aliases: "note"
2023-07-10 02:32:24 +00:00
> [!abstract]
> Aliases: "abstract", "summary", "tldr"
2023-07-10 02:32:24 +00:00
> [!info]
> Aliases: "info"
2023-07-10 02:32:24 +00:00
> [!todo]
> Aliases: "todo"
2023-07-10 02:32:24 +00:00
> [!tip]
> Aliases: "tip", "hint", "important"
2023-07-10 02:32:24 +00:00
> [!success]
> Aliases: "success", "check", "done"
2023-07-10 02:32:24 +00:00
> [!question]
> Aliases: "question", "help", "faq"
2023-07-10 02:32:24 +00:00
> [!warning]
> Aliases: "warning", "attention", "caution"
2023-07-10 02:32:24 +00:00
> [!failure]
> Aliases: "failure", "missing", "fail"
2023-07-10 02:32:24 +00:00
> [!danger]
> Aliases: "danger", "error"
2023-07-10 02:32:24 +00:00
> [!bug]
> Aliases: "bug"
2023-07-10 02:32:24 +00:00
> [!example]
> Aliases: "example"
> [!quote]
> Aliases: "quote", "cite"