ironmark 1.12.0 → 1.12.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +38 -24
- package/package.json +1 -1
- package/wasm/node.js +1 -1
- package/wasm/pkg/ironmark_bg.wasm +0 -0
package/README.md
CHANGED
|
@@ -2,32 +2,46 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://github.com/ph1p/ironmark/actions/workflows/ci.yml) [](https://www.npmjs.com/package/ironmark) [](https://crates.io/crates/ironmark)
|
|
4
4
|
|
|
5
|
-
Fast Markdown
|
|
6
|
-
|
|
7
|
-
##
|
|
5
|
+
Fast Markdown parser written in Rust with **zero third-party** parsing dependencies. Outputs HTML, AST, ANSI terminal, or Markdown. Fully compliant with [CommonMark 0.31.2](https://spec.commonmark.org/0.31.2/) (652/652 spec tests pass). Available as a Rust crate and as an npm package via WebAssembly.
|
|
6
|
+
|
|
7
|
+
## Table of Contents
|
|
8
|
+
|
|
9
|
+
- [Configuration](#configuration)
|
|
10
|
+
- [Extensions](#extensions)
|
|
11
|
+
- [Security](#security)
|
|
12
|
+
- [Other Options](#other-options)
|
|
13
|
+
- [JavaScript / TypeScript](#javascript--typescript)
|
|
14
|
+
- [Node.js](#nodejs)
|
|
15
|
+
- [AST Output](#ast-output)
|
|
16
|
+
- [HTML to Markdown](#html-to-markdown)
|
|
17
|
+
- [AST to Markdown](#ast-to-markdown)
|
|
18
|
+
- [ANSI Terminal Output](#ansi-terminal-output)
|
|
19
|
+
- [Browser / Bundler](#browser--bundler)
|
|
20
|
+
- [CLI](#cli)
|
|
21
|
+
- [Rust](#rust)
|
|
22
|
+
- [C / C++](#c--c++)
|
|
23
|
+
- [Benchmarks](#benchmarks)
|
|
24
|
+
- [Development](#development)
|
|
25
|
+
|
|
26
|
+
## Configuration
|
|
8
27
|
|
|
9
28
|
### Extensions (default `true`)
|
|
10
29
|
|
|
11
|
-
| Option
|
|
12
|
-
|
|
|
13
|
-
| Hard breaks
|
|
14
|
-
| Highlight
|
|
15
|
-
| Strikethrough
|
|
16
|
-
| Underline
|
|
17
|
-
| Tables
|
|
18
|
-
| Autolink
|
|
19
|
-
| Task lists
|
|
20
|
-
| Indented code
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
|
25
|
-
|
|
|
26
|
-
| Wiki links | `enableWikiLinks` | `enable_wiki_links` | `[[page]]` → `<a href="page">` |
|
|
27
|
-
| LaTeX math | `enableLatexMath` | `enable_latex_math` | `$inline$` and `$$display$$` → `<span class="math-…">` |
|
|
28
|
-
| Heading IDs | `enableHeadingIds` | `enable_heading_ids` | Auto `id=` on headings from slugified text |
|
|
29
|
-
| Heading anchors | `enableHeadingAnchors` | `enable_heading_anchors` | `<a class="anchor">` inside each heading (implies IDs) |
|
|
30
|
-
| Permissive headings | `permissiveAtxHeaders` | `permissive_atx_headers` | Allow `#Heading` without space after `#` |
|
|
30
|
+
| Option | JS (`camelCase`) | Rust (`snake_case`) | Description |
|
|
31
|
+
| ------------------- | -------------------------- | ----------------------------- | ------------------------------------------------------ |
|
|
32
|
+
| Hard breaks | `hardBreaks` | `hard_breaks` | Every newline becomes `<br />` |
|
|
33
|
+
| Highlight | `enableHighlight` | `enable_highlight` | `==text==` → `<mark>` |
|
|
34
|
+
| Strikethrough | `enableStrikethrough` | `enable_strikethrough` | `~~text~~` → `<del>` |
|
|
35
|
+
| Underline | `enableUnderline` | `enable_underline` | `++text++` → `<u>` |
|
|
36
|
+
| Tables | `enableTables` | `enable_tables` | Pipe table syntax |
|
|
37
|
+
| Autolink | `enableAutolink` | `enable_autolink` | Bare URLs & emails → `<a>` |
|
|
38
|
+
| Task lists | `enableTaskLists` | `enable_task_lists` | `- [ ]` / `- [x]` checkboxes |
|
|
39
|
+
| Indented code | `enableIndentedCodeBlocks` | `enable_indented_code_blocks` | 4-space indent → `<pre><code>` |
|
|
40
|
+
| Wiki links | `enableWikiLinks` | `enable_wiki_links` | `[[page]]` → `<a href="page">` |
|
|
41
|
+
| LaTeX math | `enableLateXMath` | `enable_latex_math` | `$inline$` and `$$display$$` → `<span class="math-…">` |
|
|
42
|
+
| Heading IDs | `enableHeadingIds` | `enable_heading_ids` | Auto `id=` on headings from slugified text |
|
|
43
|
+
| Heading anchors | `enableHeadingAnchors` | `enable_heading_anchors` | `<a class="anchor">` inside each heading (implies IDs) |
|
|
44
|
+
| Permissive headings | `permissiveAtxHeaders` | `permissive_atx_headers` | Allow `#Heading` without space after `#` |
|
|
31
45
|
|
|
32
46
|
### Security
|
|
33
47
|
|
|
@@ -44,7 +58,7 @@ Fast Markdown to HTML/AST parser written in Rust with **zero third-party** parsi
|
|
|
44
58
|
|
|
45
59
|
Dangerous URI schemes (`javascript:`, `vbscript:`, `data:` except `data:image/…`) are **always** stripped from link and image destinations, regardless of options.
|
|
46
60
|
|
|
47
|
-
### Other
|
|
61
|
+
### Other Options
|
|
48
62
|
|
|
49
63
|
| Option | JS (`camelCase`) | Rust (`snake_case`) | Default | Description |
|
|
50
64
|
| ------------------- | -------------------- | --------------------- | ------- | ------------------------------------------------- |
|