HeadingAnchorExtension

Extension for adding auto generated IDs to headings. <p> Create it with {@link #create()} or {@link #builder()} and then configure it on the renderer builder ({@link HtmlRenderer.Builder#extensions(Iterable)}). <p> 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: <pre><code> # Heading # Heading </code></pre> will result in <pre><code> <h1 id="heading">Heading</h1> <h1 id="heading-1">Heading</h1> </code></pre>

@see IdGenerator the IdGenerator class if just the ID generation part is needed

class HeadingAnchorExtension : HtmlRendererExtension {

static Extension create();

static Builder builder();

void extend(HtmlRenderer.Builder rendererBuilder);

class Builder;

}

Members

Classes

Builder class Builder: Undocumented in source.

Functions

extend void extend(HtmlRenderer.Builder rendererBuilder): Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

builder Builder builder(): @return a builder to configure the extension settings
create Extension create(): @return the extension built with default settings

Inherited Members

From HtmlRendererExtension

extend void extend(Builder rendererBuilder): Undocumented in source.