Allows to add block-styled side content to your Inkdrop notes.
As I mainly write my notes in markdown using Inkdrop, admonitions help me to write a more structured content and collapsible blocks can make my notes easier to read.
The inspiration came from the MkDocs admonition extension.
ipm install admonition
There are currently 10 different admonition types: note
, info
, question
, abstract
, danger
, warning
, success
, fail
, example
and spoiler
.
In order to create a new info
admonition with the title "Info" you can use following syntax:
[[info | Info]]
| **markdown** content
In order to create a block without a title just leave it out:
[[info]]
| This is an `info` admonition without a title.
The spoiler
admonition is special as it is collapsible, doesn't have an icon and always requires a title:
[[spoiler | Spoiler]]
| **markdown** content
To make a "normal" admontion collapsible just add -spoiler
to the type e.g. abstract-spoiler
.
[[abstract-spoiler | Abstract]]
| **markdown** content
As soon as one makes a "normal" admonition collapsible the title becomes mandatory.
You can add any kind of markdown content inside of an admonition, e.g.:
[[note | Note]]
| My note content
|
| | This | is |
| |:-----|:-----|
| | a | test |
|
| ```js
| const s = "test";
| ```
| [[info | Info]]
| | another block
By default the shortcut Ctrl + Alt + a will add a new (note) admonition and everything that is selected with the cursor will be automatically placed inside of it.
Remaining admonitions: