Class HeadingAnchorExtension
- java.lang.Object
-
- org.commonmark.ext.heading.anchor.HeadingAnchorExtension
-
- All Implemented Interfaces:
Extension
,HtmlRenderer.HtmlRendererExtension
public class HeadingAnchorExtension extends java.lang.Object implements HtmlRenderer.HtmlRendererExtension
Extension for adding auto generated IDs to headings.Create it with
create()
orbuilder()
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:
will result in# Heading # Heading
<h1 id="heading">Heading</h1> <h1 id="heading-1">Heading</h1>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
HeadingAnchorExtension.Builder
-
Constructor Summary
Constructors Modifier Constructor Description private
HeadingAnchorExtension(HeadingAnchorExtension.Builder builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static HeadingAnchorExtension.Builder
builder()
static Extension
create()
void
extend(HtmlRenderer.Builder rendererBuilder)
-
-
-
Constructor Detail
-
HeadingAnchorExtension
private HeadingAnchorExtension(HeadingAnchorExtension.Builder builder)
-
-
Method Detail
-
create
public static 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(HtmlRenderer.Builder rendererBuilder)
- Specified by:
extend
in interfaceHtmlRenderer.HtmlRendererExtension
-
-