Quotes

Overview

Quotes is an extension that offers a more modern take on blockquotes compared to the one that ships with Python Markdown by default.

Python Markdown is an old-school parser that aims to follow the original Markdown specification. When implementing blockquotes, it follows the guidance that describes the ability to lazily specify content under a blockquote as shown below. Notice that two blocks of text can be specified without having to specify > on the empty lines between the blocks.

> This is a paragraph

> This is another paragraph.

The problem with this approach is that if you have a need to have two separate blockquotes, this becomes difficult.

The Quotes extensions follows logic that is seen in more modern approaches to Markdown where each blockquote is distinct and separate.

> This is a paragraph

> This is another paragraph.

It should be noted that since this extension does not use lazy formatting, you should be stricter with your leading blockquote >. For instance, when using SuperFences, you will find that these must be fully contained in the blockquotes. In the past, the lazy handling would have allowed a more relaxed behavior.

This will work.

> ```
> Test
>
> Test
> ```

This will not.

> ```
> Test

> Test
> ```

Callouts

GitHub and Obsidian allow for specifying admonitions (also known as alerts or callouts) by using a special syntax at the start of a blockquote. While Obsidian does this with a more feature rich syntax, GitHub offers a more stripped down version.

The Quotes extensions allows you to opt-in to specifying admonitions in a similar approach that is compatible with Obsidian and GitHub.

Quotes will take the special blockquote syntax and output HTML that matches the output of Admonitions or Details.

To specify normal callouts, simply ensure the that the first line of a blockquote contains a class name in within [!<type>] where <type> is the specific callout type.

> [!note]
> Here is a note

Borrowing from Obsidian, Quotes also enables a few more advanced features. If you'd like a custom title, simply provide one on the same line as the class specifier. If one is not provided, a title is sourced from the first the class.

> [!tip] Here's a tip
> Use a custom title!

To make a collapsible callout, just add + (open) or - (closed) immediately after the class specifier.

> [!danger]- Click to see more
> I'm collapsible.

Lastly, if you need to specify multiple classes, you can utilize the Obsidian approach and separate each class with |. The first class will be used as the type and also the title if no title is provided, but all classes will be applied to the callout.

> [!warning | inline | end]
> Make inline and set at the end.

A paragraph.

While GitHub does not support nesting, nesting is also supported which aligns with Obsidian.

> [!note]
> Content
> > [!danger]
> > Content
> > > [!important]
> > > Content
> >
> > Content
>
> > [!tip]

Options