Index

A D G H I M O P S T
Alle Klassen und Schnittstellen|Alle Packages

A

addStep(MarkdownProcessingStep) - Methode in Klasse io.github.astrapisixtynine.markdownslugger.core.MarkdownProcessor

Adds a new processing step to the Markdown pipeline

AnchorIdInjector - Klasse in io.github.astrapisixtynine.markdownslugger.pipeline

Processing step that injects anchor IDs into headings Modifies the Markdown content by appending {#slug} to each heading Ensures internal links work in tools like Pandoc and EPUB readers

AnchorIdInjector() - Konstruktor für Klasse io.github.astrapisixtynine.markdownslugger.pipeline.AnchorIdInjector

D

defaultPipeline(SlugStrategy) - Statische Methode in Klasse io.github.astrapisixtynine.markdownslugger.core.MarkdownProcessor

Creates a default pipeline of steps using the provided SlugStrategy Includes heading extraction, slug mapping, TOC generation, and anchor injection

DefaultSlugStrategy - Klasse in io.github.astrapisixtynine.markdownslugger.slug

Default implementation of the SlugStrategy interface Converts headings to lowercase, removes special characters, and replaces spaces with dashes

DefaultSlugStrategy(SlugifyConfig) - Konstruktor für Klasse io.github.astrapisixtynine.markdownslugger.slug.DefaultSlugStrategy

Constructs a DefaultSlugStrategy with the specified slugification configuration

G

getAllowedCharactersRegex() - Methode in Klasse io.github.astrapisixtynine.markdownslugger.slug.SlugifyConfig

getReplacements() - Methode in Klasse io.github.astrapisixtynine.markdownslugger.slug.SlugifyConfig

getWhitespaceReplacement() - Methode in Klasse io.github.astrapisixtynine.markdownslugger.slug.SlugifyConfig

H

HeadingExtractor - Klasse in io.github.astrapisixtynine.markdownslugger.pipeline

Processing step that extracts headings from the Markdown content Stores heading texts and their corresponding levels in the context

HeadingExtractor() - Konstruktor für Klasse io.github.astrapisixtynine.markdownslugger.pipeline.HeadingExtractor

headingLevels - Variable in Klasse io.github.astrapisixtynine.markdownslugger.core.MarkdownContext

A list of heading levels corresponding to each heading (e.g., 1 for '#', 2 for '##')

headings - Variable in Klasse io.github.astrapisixtynine.markdownslugger.core.MarkdownContext

A list of all heading texts extracted from the Markdown content

I

io.github.astrapisixtynine.markdownslugger.core - Package io.github.astrapisixtynine.markdownslugger.core

io.github.astrapisixtynine.markdownslugger.pipeline - Package io.github.astrapisixtynine.markdownslugger.pipeline

io.github.astrapisixtynine.markdownslugger.slug - Package io.github.astrapisixtynine.markdownslugger.slug

isCollapseDashes() - Methode in Klasse io.github.astrapisixtynine.markdownslugger.slug.SlugifyConfig

isRemoveAccents() - Methode in Klasse io.github.astrapisixtynine.markdownslugger.slug.SlugifyConfig

isStripNonAlphanumeric() - Methode in Klasse io.github.astrapisixtynine.markdownslugger.slug.SlugifyConfig

isToLowerCase() - Methode in Klasse io.github.astrapisixtynine.markdownslugger.slug.SlugifyConfig

isTrimEdges() - Methode in Klasse io.github.astrapisixtynine.markdownslugger.slug.SlugifyConfig

M

MarkdownContext - Klasse in io.github.astrapisixtynine.markdownslugger.core

MarkdownContext holds the state used and modified throughout the Markdown processing pipeline It contains the original Markdown content, extracted heading texts and their levels, generated slugs, and a generated table of contents.

MarkdownContext() - Konstruktor für Klasse io.github.astrapisixtynine.markdownslugger.core.MarkdownContext

MarkdownProcessingStep - Schnittstelle in io.github.astrapisixtynine.markdownslugger.core

Interface for processing steps that operate on a MarkdownContext Implementations should perform a specific transformation or analysis on the Markdown document (e.g., heading extraction, TOC generation)

MarkdownProcessor - Klasse in io.github.astrapisixtynine.markdownslugger.core

MarkdownProcessor executes a pipeline of MarkdownProcessingStep instances Each step modifies or enriches the provided MarkdownContext This processor can be used to extract headings, generate slugs, create a TOC, inject anchor IDs, and more

MarkdownProcessor() - Konstruktor für Klasse io.github.astrapisixtynine.markdownslugger.core.MarkdownProcessor

O

originalContent - Variable in Klasse io.github.astrapisixtynine.markdownslugger.core.MarkdownContext

The original Markdown content to be processed

P

process(MarkdownContext) - Methode in Schnittstelle io.github.astrapisixtynine.markdownslugger.core.MarkdownProcessingStep

Processes and optionally modifies the provided MarkdownContext

process(MarkdownContext) - Methode in Klasse io.github.astrapisixtynine.markdownslugger.core.MarkdownProcessor

Runs all configured processing steps in order on the given context

process(MarkdownContext) - Methode in Klasse io.github.astrapisixtynine.markdownslugger.pipeline.AnchorIdInjector

Modifies the Markdown content by appending anchor IDs ({#slug}) to each heading Ensures the output is compatible with Pandoc and EPUB generators

process(MarkdownContext) - Methode in Klasse io.github.astrapisixtynine.markdownslugger.pipeline.HeadingExtractor

Extracts headings and their levels from the Markdown content Updates the context with lists of heading texts and their levels

process(MarkdownContext) - Methode in Klasse io.github.astrapisixtynine.markdownslugger.pipeline.TocGenerator

Generates a Markdown-formatted table of contents (TOC) Uses the headings, their levels, and slugs from the context The result is stored in context.toc

process(MarkdownContext) - Methode in Klasse io.github.astrapisixtynine.markdownslugger.slug.SlugMapper

Maps each extracted heading to a slug using the configured strategy Stores the slugs in the context

S

SlugifyConfig - Klasse in io.github.astrapisixtynine.markdownslugger.slug

Configuration class for controlling how Markdown headings are converted into slugs Provides fine-grained control over character replacements, case transformation, accent removal, whitespace handling, character filtering, and formatting behavior

SlugifyConfig(Map<String, String>, boolean, boolean, String, boolean, boolean, boolean, String) - Konstruktor für Klasse io.github.astrapisixtynine.markdownslugger.slug.SlugifyConfig

Constructs a new slugification configuration

SlugMapper - Klasse in io.github.astrapisixtynine.markdownslugger.slug

Processing step that generates slugs from extracted headings Uses the configured SlugStrategy to create a list of slugs and stores them in the context

SlugMapper(SlugStrategy) - Konstruktor für Klasse io.github.astrapisixtynine.markdownslugger.slug.SlugMapper

Constructs a SlugMapper with the specified SlugStrategy

slugs - Variable in Klasse io.github.astrapisixtynine.markdownslugger.core.MarkdownContext

A list of slugs generated from each heading, used for anchors and links

SlugStrategy - Schnittstelle in io.github.astrapisixtynine.markdownslugger.slug

Strategy interface for generating slugs from headings Used to create URL-safe fragment identifiers for Markdown links

T

toc - Variable in Klasse io.github.astrapisixtynine.markdownslugger.core.MarkdownContext

The generated table of contents in Markdown format

TocGenerator - Klasse in io.github.astrapisixtynine.markdownslugger.pipeline

Processing step that builds a Markdown table of contents (TOC) Uses heading levels and slugs to create an indented list of links

TocGenerator() - Konstruktor für Klasse io.github.astrapisixtynine.markdownslugger.pipeline.TocGenerator

toSlug(String) - Methode in Klasse io.github.astrapisixtynine.markdownslugger.slug.DefaultSlugStrategy

Converts the given heading to a slug Applies lowercase transformation, removes non-alphanumeric characters, and replaces spaces with dashes

toSlug(String) - Methode in Schnittstelle io.github.astrapisixtynine.markdownslugger.slug.SlugStrategy

Converts the given heading text into a URL-friendly slug

A D G H I M O P S T
Alle Klassen und Schnittstellen|Alle Packages