The aim of this Markdown library is to provide a pure Elm implementation of Markdown which offers a small set of extensions, along with options:
This **is** a test: $a^2 + b^2 = c^2$.is properly rendered.
See markdown.minilatex.app for a demo of the latest implementation. The package on which this app relies can be found on the Elm package manager
To convert text to Html, do something like this:
Markdown.Elm.toHtml ExtendedMath "This **is** a test: $a^2 + b^2 = c^2$."According to your needs, you can also use the
Standard or Extended options.
The demo app resides in ./app-test of the
Github repository.
To run
it, go into that folder and say sh make.sh. Then
double-click on index.html.
The style used by the library is entirely determined by the
definitions of the CSS classes given in index.html.
See the code in ./app-test/index.html.
You can easily reconfigure this CSS to satsify your
own esthetics.
The javascript code in .app/index.html calls MathJax.js
to render the mathematical text. It should be copied
verbatim for your own app if you use the ExtendedMath option.
I am trying to be conservative about extensions to
Markdown. However, there are two that I thought
important enough to add: poetry blocks and verbatim text.
Poetry blocks are
are like quotation blocks, except that they begin
with ">>" instead of ">". Line endings are respected
in poetry blocks. Verbatim blocks are like code blocks,
except that they are set off by four backticks instead of
three. No syntax coloring is applied to verbatim blocks.
Please write me at [email protected] or post an issue on the Github repository regarding bugs or anything else. I will steer this library towards the Commonmark spec to the greatest extent possible by the method of successive approximations