HeadingAnchorExtension (commonmark-ext-heading-anchor 0.21.1 API)

java.lang.Object
- org.commonmark.ext.heading.anchor.HeadingAnchorExtension

All Implemented Interfaces:

org.commonmark.Extension, org.commonmark.renderer.html.HtmlRenderer.HtmlRendererExtension
```
public class HeadingAnchorExtension
extends java.lang.Object
implements org.commonmark.renderer.html.HtmlRenderer.HtmlRendererExtension
```
Extension for adding auto generated IDs to headings.
Create it with create() or builder() and then configure it on the renderer builder (HtmlRenderer.Builder.extensions(Iterable)).
The heading text will be used to create the id. Multiple headings with the same text will result in appending a hyphen and number. For example:
```
 # Heading
 # Heading
 
```
will result in
```
 <h1 id="heading">Heading</h1>
 <h1 id="heading-1">Heading</h1>
 
```
See Also:

the IdGenerator class if just the ID generation part is needed

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class HeadingAnchorExtension.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static HeadingAnchorExtension.Builder`	`builder()`
`static org.commonmark.Extension`	`create()`
`void`	`extend(org.commonmark.renderer.html.HtmlRenderer.Builder rendererBuilder)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static org.commonmark.Extension create()
```
    Returns:
    
    the extension built with default settings
  - builder
```
public static HeadingAnchorExtension.Builder builder()
```
    Returns:
    
    a builder to configure the extension settings
  - extend
```
public void extend(org.commonmark.renderer.html.HtmlRenderer.Builder rendererBuilder)
```
    Specified by:
    
    extend in interface org.commonmark.renderer.html.HtmlRenderer.HtmlRendererExtension