MarkdownPlus

MarkdownPlus

The Kirby-plugin MarkdownPlus replaces Kirby's built-in Markdown resp. MarkdownExtra compiler.

MarkdownPlus provides a small number of useful extensions.

Installation

→ see chapt. {{ link(notes) }}.

Overview of Extended Features

Orderd List with Start Value:

Lets you define the start value of an ordered list.
Example:

 5!. fife		// -> 5. fife
 1.  six		// -> 6. six

→ see chapt. {{ link(https://pagefactory.info/markdownplus/en/reference/numbered_lists) }}

Definition Lists:

Support for HTML <dl> tag
Example:

Definition Term:
: Definition Description&hellip;

→ see chapt. {{ link(https://pagefactory.info/markdownplus/en/reference/definition-lists) }}

Special HTML Tags:

Provides codes to invoke a number of HTML tags:
<sub>, <sup>, <ins>, <mark>, <ins>, <del>, <key>, <samp>
Example:

Lorem ==Ipsum== Dolor   // renders as <mark>

→ see chapt. {{ link(https://pagefactory.info/markdownplus/en/syntax#pfy-section-3, Miscellaneous HTML Tags) }}

Tabulators:

Syntax element that mimicks tabulators (which HTML does not support natively)
Example:

Aaaaaa     >> Bbb
C       >> Ddddddd

→ see chapt. {{ link(https://pagefactory.info/markdownplus/en/reference/tabulators) }}

AsciiTables:

Alternative syntax for defining tables.
For instance, allows to spread cells of a row over multiple lines in the source code
Example:

|=== 'Caption'
|# Col 1 | Col 2
|---
| A | B
|---
| C 
| D <br> Lorem Ipsum
|===

Thus, |--- terminates a row and | begins a new cell.
→ see chapt. {{ link(https://pagefactory.info/markdownplus/en/reference/asciitables) }}

DivBlocks:

This is a syntax to define <div> blocks which can contain any kind of content (without resorting to HTML).
Example:

@@@ .box background:yellow
Lorem
@@@ 

→ see chapt. {{ link(https://pagefactory.info/markdownplus/en/reference/divblocks) }}

Attribute Injections:

Allows to apply HTML attributes to content elements. Supported attributes: classes, styles , data or aria etc.
Example:

# Header {: .h2 aria-labelledby=#descr}

→ see chapt. {{ link(https://pagefactory.info/markdownplus/en/reference/attribute_injection) }}

Include Files:

A command (that extends KirbyTags) to load source files and include them in the rendered output.
Example:

(include: *.md)
Icons:

Renders royalty free SVG icons.
Example:

 :diamond:

→ see chapt. {{ link(https://pagefactory.info/markdownplus/en/reference/icons) }}

Comment Handling:

MarkdownPlus detects "c-style" comments in .md sources and excludes them:

  • everything following // comment…
  • everything between /* and */
  • evertything following __END__

Likewise, KirbyTag (include: …) will skip any files starting with #, e.g. #oldversion.md.

MarkdownPlus

The Kirby-plugin MarkdownPlus replaces Kirby's built-in Markdown resp. MarkdownExtra compiler.

MarkdownPlus provides a small number of useful extensions.

Installation

→ see chapt. Tech. Notes.

Overview of Extended Features

Orderd List with Start Value:

Lets you define the start value of an ordered list.
Example:

 5!. fife		// -> 5. fife
 1.  six		// -> 6. six

→ see chapt. https://pagefactory.info/markdownplus/en/reference/numbered_lists

Definition Lists:

Support for HTML <dl> tag
Example:

Definition Term:
: Definition Description&hellip;

→ see chapt. Definition Lists

Special HTML Tags:

Provides codes to invoke a number of HTML tags:
<sub>, <sup>, <ins>, <mark>, <ins>, <del>, <key>, <samp>
Example:

Lorem ==Ipsum== Dolor   // renders as <mark>

→ see chapt. Miscellaneous HTML Tags

Tabulators:

Syntax element that mimicks tabulators (which HTML does not support natively)
Example:

Aaaaaa     >> Bbb
C       >> Ddddddd

→ see chapt. Tabulators

AsciiTables:

Alternative syntax for defining tables.
For instance, allows to spread cells of a row over multiple lines in the source code
Example:

|=== 'Caption'
|# Col 1 | Col 2
|---
| A | B
|---
| C 
| D <br> Lorem Ipsum
|===

Thus, |--- terminates a row and | begins a new cell.
→ see chapt. AsciiTables

DivBlocks:

This is a syntax to define <div> blocks which can contain any kind of content (without resorting to HTML).
Example:

@@@ .box background:yellow
Lorem
@@@ 

→ see chapt. DivBlocks

Attribute Injections:

Allows to apply HTML attributes to content elements. Supported attributes: classes, styles , data or aria etc.
Example:

# Header {: .h2 aria-labelledby=#descr}

→ see chapt. Attribute Injection

Include Files:

A command (that extends KirbyTags) to load source files and include them in the rendered output.
Example:

(include: *.md)
Icons:

Renders royalty free SVG icons.
Example:

 :diamond:

→ see chapt. Icons

Comment Handling:

MarkdownPlus detects "c-style" comments in .md sources and excludes them:

  • everything following // comment…
  • everything between /* and */
  • evertything following __END__

Likewise, KirbyTag (include: …) will skip any files starting with #, e.g. #oldversion.md.

MarkdownPlus