callout

package module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 26, 2023 License: MIT Imports: 6 Imported by: 0

README

goldmark-obsidian-callout

Extension for the goldmark markdown parser. Parses obsidian-flavored callouts.

Examples

> [!note]+ Sidenote
> This is something really interesting

Gets transformed into:

Sidenote

This is something really interesting

<details class="callout" data-callout="note" open>
  <summary>Sidenote</summary>
	<p>This is something <strong>really</strong> interesting</p>
</details>

The CSS class and data-callout are there to make the callouts compatible with Obsidian stylesheets and themes.

Features

  • Recognizes all Obsidian callout types
  • Custom titles
  • Multiple paragraphs inside the callout
  • Non-collapsible callouts by default (requires Javascript - preview in browser)
  • Nested callouts
  • Default callout title accoring to the callout type

Contributions are very much welcome!

Credit

Project bootstrapped by the mangoubrella/goldmark-figure project. Thanks!

License

MIT

Documentation

Index

Constants

This section is empty.

Variables

View Source
var ObsidianCallout = &obsidianCalloutExtension{}

ObsidianCallout is an extension to render <details> and <summary> elements for Obsidian flavored markdown style

Functions

This section is empty.

Types

This section is empty.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL