quartz/docs/features/callouts.md

105 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

2023-07-10 05:32:24 +03:00
---
title: Callouts
2023-08-11 10:31:44 +03:00
tags:
- plugin/transformer
2023-07-10 05:32:24 +03:00
---
2023-08-11 10:31:44 +03: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 05:32:24 +03:00
> [!warning]
2023-07-23 03:27:41 +03: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 05:32:24 +03:00
2023-08-11 10:31:44 +03: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 10:31:44 +03:00
## Showcase
2023-07-10 05:32:24 +03:00
> [!info]
> Default title
> [!question]+ Can callouts be _nested_?
2023-07-23 03:27:41 +03:00
>
> > [!todo]- Yes!, they can. And collapsed!
2023-07-23 03:27:41 +03:00
> >
> > > [!example] You can even use multiple layers of nesting.
2023-07-10 05:32:24 +03:00
> [!EXAMPLE] Examples
>
> Aliases: example
> [!note] Notes
>
> Aliases: note
2023-07-23 03:27:41 +03:00
> [!abstract] Summaries
2023-07-10 05:32:24 +03:00
>
> Aliases: abstract, summary, tldr
2023-07-23 03:27:41 +03:00
> [!info] Info
2023-07-10 05:32:24 +03:00
>
> Aliases: info, todo
2023-07-23 03:27:41 +03:00
> [!tip] Hint
2023-07-10 05:32:24 +03:00
>
> Aliases: tip, hint, important
2023-07-23 03:27:41 +03:00
> [!success] Success
2023-07-10 05:32:24 +03:00
>
> Aliases: success, check, done
2023-07-23 03:27:41 +03:00
> [!question] Question
2023-07-10 05:32:24 +03:00
>
> Aliases: question, help, faq
2023-07-23 03:27:41 +03:00
> [!warning] Warning
2023-07-10 05:32:24 +03:00
>
> Aliases: warning, caution, attention
2023-07-23 03:27:41 +03:00
> [!failure] Failure
2023-07-10 05:32:24 +03:00
>
> Aliases: failure, fail, missing
> [!danger] Error
>
> Aliases: danger, error
> [!bug] Bug
>
> Aliases: bug
> [!quote] Quote
>
> Aliases: quote, cite