0.1.1 • Published 7 years ago

wiki-plugin-markedex v0.1.1

Weekly downloads
4
License
MIT
Repository
github
Last release
7 years ago

Federated Wiki - Marked with KaTeX and FedWiki support Plug-in

MarkedEx is a Federated Wiki plug-in to create paragraphs with Markdown.

This plug-in was initially intented to simply provide KaTeX support to make math rendering faster, but eventually extended typesetting support with Markdown was deemed also necessary.

How it works

This plug-in uses Marked to render Markdown with the following modifications:

KaTeX support

Surround your LaTeX inline math with dollar signs ($) to render the math in text:

Inline math rendering

For larger, centered math blocks use /[ /]:

Block math

Federated Wiki links

Because Marked comes with its own sanitizer, link support was added to Marked manually. Use [[ ]] to add internal links, just as in Federal Wiki itself.

NOTE: Because link creation is done through Marked, it cannot currently build proper "pathing" that Federal Wiki requires to access pages from other wikis. This could be fixed in the future.

Alias link

Unlike in Federated Wiki, you can link to the same page using different link names (aliases). Do that with [[ <alias name> ]]( <original name> ). This will create a link that will display <alias name> but will link internally to <original name>:

Alias links

NOTE: Do not create pages with this setup. Currently Federated Wiki uses the value in <a> tag to set the title of the new page (even though it has pageName data in the tag.) If you use the alias link to create a new page, it will use the alias as the title for a new page instead of the intended original name. However, if the page exists, it will work just fine.