PluginMarkDown

NacoWiki MarkDown

This plugin is used to provide Markdown functionality to NacoWiki. It provides the following:

• Markdown renderer with extended syntax.
• CodeMirror for editor.
• Allows the inclusion of a YAML block at the beginning to store meta data.

Meta data

Meta data is stored in a block at the top of the file of the form:

---
title: sample block
date: "2023-03-02"
---

Only the title attribute is used by NacoWiki. But any data can be stored in the YAML block.

Markup

In addition to Parsedown and ParsedownExtra markup it adds the following extensions:

• checkboxes in lists [x] and [ ] markup

• table span. See markup

• ~~ strike-through (del)

• ++ insert (ins)

• ^^ ^superscript (sup)

• ,, _subscript (sub)

• == keyboard (kbd)

• ?? highlight (mark)

• "\" at the end of the line to generate a line break

• Links ending with ^ will open in a new window.

• headown

  • header html tags in the content start at H2 (since H1 is used by the wiki's document title.
  • #++ and #-- is used to increment headown level. (Use this in combination with file includes.

• diagrams in fenced code blocks.

  • Adding to a fenced code block a tag such as:
    • graphviz-dot
    • graphviz-neato
    • graphviz-fdp
    • graphviz-sfdp
    • graphviz-twopi
    • graphviz-circo
    • lineart or bob or aafigure : parsed using svgbob
  • This will render the given code as a SVG.

• Allows the use of fenced code blocks with tags to allow for syntax highlighting.

  • Lines begining with ```tag where tag is a language for syntax highlighting.

• Markdown libraries:

  • Parsedown
  • PardownExtra
  • [toc] tag implemented using the TOC extension but tweaked to allow for case insensitive tags.

• Unordered list are tweaked to my personal preferences.

• @phpcod PluginMarkDown

---

• plugins/PluginMarkDown.php,12

  ---