markdown-to-html
markdown-to-html copied to clipboard
g105b
The simplest pure JavaScript markdown parser
markdown-to-html
The simplest pure JavaScript markdown parser
Project status
Currently the project implements a bare minimum parser, through a set of regular expressions. All features are tested but some features of Markdown currently only have very basic support. See CONTRIBUTING.md for information on how to help enhance this project.
Browser usage
Plain JavaScript
It is possible to use this parser in a web context without using any dependency management. Adding the source directly to a website source will attach the MarkdownToHtml object to the current window. Check out the following example for the simplest in-browser usage:
<!doctype html>
<script src="./src/markdown-to-html.min.js"></script>
<div id="example-markdown-content">
# Hello, Markdown!
Here is some example **formatting** in _Markdown_.
The following JavaScript will transform this content to clean HTML.
</div>
<script>
var element = document.getElementById("example-markdown-content");
element.innerHTML = MarkdownToHtml.parse(element.innerHTML);
</script>
Requiring with a dependency management tool
/* TODO */
Node compatibility
Require the script in node to obtain an object with the single parse method:
var markdownToHtml = require("./src/markdown-to-html.js"),
markdown = "# This is a heading";
markdownToHtml.parse(markdown); // Returns: <h1>This is a heading</h1>
Contributing
Projects like this can't exist without help from the community. Please see CONTRIBUTING.md for information on how to contribute feature and fixes.
g105b