A feature-rich markdown renderer
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
Trivernis 8fe0c2d040
Create LICENSE
5 years ago
src Initial commit 5 years ago
.gitignore Initial commit 5 years ago
LICENSE Create LICENSE 5 years ago
README.md Initial commit 5 years ago
package-lock.json Initial commit 5 years ago
package.json Initial commit 5 years ago
tsconfig.json Initial commit 5 years ago

README.md

markdown-super

Markdown-Super is a markkdown-parser using markdown it that allows including other markdown-documents and manage markdown-it plugins inside the document itself.

Including other markdown documents

A document can be included by using

[!include]: path/to/file

Managing markdown-it plugins

The usage of a markdown-it plugin inside a document can be decleared by using

[!use]: plugin1, plugin2, plugin3

The plugin names are listed in the following table. Basically it is just the package name with the markdown-it removed:

module import name
markdown-it-footnote footnote
markdown-it-anchor anchor
markdown-it-mark mark
markdown-it-sub sub
markdown-it-attrs attrs
markdown-it-abbr abbr
markdown-it-checkbox checkbox
markdown-it-imsize imsize
markdown-it-highlightjs highlightjs
markdown-it-prism prism
markdown-it-toc-done-right toc-done-right
markdown-it-smartarrows smartarrows
markdown-it-plantuml plantuml
markdown-it-mathjax mathjax
markdown-it-math math

For example you can declare the use of markdown-it-emoji the following:

[!use]: emoji