Skip to content

Commit 7f74d2c

Browse files
committed
bring up the requirement
1 parent eefe9ce commit 7f74d2c

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ Instead of grabbing footnote bodies with a single regex and patching the output
1616
npm install marked-github-footnote
1717
```
1818

19+
Requires `marked` >= 12.
20+
1921
## Usage
2022

2123
```javascript
@@ -104,8 +106,6 @@ You get this HTML:
104106
| `heading` | `"Footnotes"` | Text of the visually hidden footnotes section heading. |
105107
| `backRefLabel` | `"Back to reference {0}{1}"` | aria-label template for back-reference links. `{0}` is the reference number, `{1}` is the suffix (e.g. `"-2"`). Supports i18n. |
106108

107-
Requires `marked` >= 12.
108-
109109
## Why this instead of `marked-footnote`?
110110

111111
[marked-footnote](https://github.com/markedjs/marked-footnote) is the official marked extension for footnotes. `marked-github-footnote` differs in several important ways:

0 commit comments

Comments
 (0)