1
0
mirror of https://gitlab.com/MisterBiggs/brain-quartz.git synced 2025-07-24 07:11:24 +00:00
Files
.github
content
docs
advanced
features
Docker Support.md
Latex.md
Mermaid diagrams.md
Obsidian compatibility.md
OxHugo compatibility.md
RSS Feed.md
SPA Routing.md
backlinks.md
breadcrumbs.md
callouts.md
darkmode.md
explorer.md
folder and tag listings.md
full-text search.md
graph view.md
i18n.md
index.md
popover previews.md
private pages.md
recent notes.md
syntax highlighting.md
table of contents.md
upcoming features.md
wikilinks.md
images
tags
authoring content.md
build.md
configuration.md
hosting.md
index.md
layout.md
migrating from Quartz 3.md
philosophy.md
setting up your GitHub repository.md
showcase.md
upgrading.md
quartz
.gitattributes
.gitignore
.npmrc
.prettierignore
.prettierrc
CODE_OF_CONDUCT.md
Dockerfile
LICENSE.txt
README.md
globals.d.ts
index.d.ts
package-lock.json
package.json
quartz.config.ts
quartz.layout.ts
tsconfig.json
brain-quartz/docs/features/callouts.md
2024-01-31 11:41:27 -08:00

2.1 KiB

title, tags
title tags
Callouts
plugin/transformer

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.

Warning

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().

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.

.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 to help you do that.

Showcase

[!info] Default title

[!question]+ Can callouts be nested?

[!todo]- Yes!, they can. And collapsed!

[!example] You can even use multiple layers of nesting.

[!EXAMPLE] Examples

Aliases: example

[!note] Notes

Aliases: note

[!abstract] Summaries

Aliases: abstract, summary, tldr

[!info] Info

Aliases: info, todo

[!tip] Hint

Aliases: tip, hint, important

[!success] Success

Aliases: success, check, done

[!question] Question

Aliases: question, help, faq

[!warning] Warning

Aliases: warning, caution, attention

[!failure] Failure

Aliases: failure, fail, missing

[!danger] Error

Aliases: danger, error

[!bug] Bug

Aliases: bug

[!quote] Quote

Aliases: quote, cite