Skip to content

Commit

Permalink
README: Bump version, add new APIs
Browse files Browse the repository at this point in the history
  • Loading branch information
robinst committed Sep 18, 2024
1 parent 0ea7634 commit ddf51f3
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Coordinates for core library (see all on [Maven Central]):
<dependency>
<groupId>org.commonmark</groupId>
<artifactId>commonmark</artifactId>
<version>0.22.0</version>
<version>0.23.0</version>
</dependency>
```

Expand Down Expand Up @@ -233,6 +233,7 @@ all of them via methods on `Parser.Builder`
- Parsing of inline content can be extended/overridden with `customInlineContentParserFactory`
- Parsing of [delimiters](https://spec.commonmark.org/0.31.2/#emphasis-and-strong-emphasis) in inline content can be
extended with `customDelimiterProcessor`
- Processing of links can be customized with `linkProcessor` and `linkMarker`

#### Thread-safety

Expand Down Expand Up @@ -265,7 +266,7 @@ First, add an additional dependency (see [Maven Central] for others):
<dependency>
<groupId>org.commonmark</groupId>
<artifactId>commonmark-ext-gfm-tables</artifactId>
<version>0.22.0</version>
<version>0.23.0</version>
</dependency>
```

Expand Down Expand Up @@ -307,6 +308,21 @@ Enables tables using pipes as in [GitHub Flavored Markdown][gfm-tables].

Use class `TablesExtension` in artifact `commonmark-ext-gfm-tables`.

### Footnotes

Enables footnotes like in [GitHub](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#footnotes)
or [Pandoc](https://pandoc.org/MANUAL.html#footnotes):

```
Main text[^1]
[^1]: Additional text in a footnote
```

Inline footnotes like `^[inline footnote]` are also supported when enabled via `FootnotesExtension.Builder#inlineFootnotes`.

Use class `FootnotesExtension` in artifact `commonmark-ext-footnotes`.

### Heading anchor

Enables adding auto generated "id" attributes to heading tags. The "id"
Expand Down

0 comments on commit ddf51f3

Please sign in to comment.