What gets converted
The HTML comes from the marked library with GitHub Flavored Markdown on, cleaned by DOMPurify, then indented so it is easy to read. Each row below was checked against the tool's actual output.
| Markdown | Converted? | HTML output |
|---|---|---|
# to ###### headings |
Yes | <h1> to <h6> with GitHub-style id attributes, so #installation links work |
| Paragraphs | Yes | <p> |
| Two trailing spaces or a trailing backslash | Yes | <br> |
**bold**, *italic*, ~~strike~~ |
Yes | <strong>, <em>, <del> |
Links and bare www. addresses |
Yes | <a href> |
| Images | Yes | <img src alt>, with the path kept exactly as written |
| Bulleted, numbered and nested lists | Yes | <ul>, <ol> and <li> |
Task lists - [x] |
Yes | <li> with a disabled checkbox <input> |
| Pipe tables with alignment | Yes | <table> with <thead>, <tbody> and align attributes |
| Fenced code with a language | Yes | <pre><code class="hljs language-js"> with highlight.js spans; the full document's styles include the colors |
Blockquotes and --- rules |
Yes | <blockquote> and <hr> |
Safe raw HTML such as <details> or <sup> |
Yes | Kept |
<script>, <style>, forms, onclick, javascript: links |
No | Removed |
| YAML front matter | Partial | Becomes an <hr> and an <h2>, so delete it first |
Math ($x^2$, $$...$$) |
Yes | KaTeX HTML; the full document links the KaTeX stylesheet it needs |
| Mermaid diagrams | Yes | Inline <svg> |
| Footnotes | No | Not converted |
The full-document option adds <!doctype html>, a UTF-8 charset, a viewport tag and a <title> taken from the first heading. The optional styles are a short embedded stylesheet for readable type, tables and code.