MarkdownLinkTransformer Class

Namespace
Kampute.DocToolkit.Formatters
Assembly
  • Kampute.DocToolkit.dll

Definition

Represents a text transformer that processes URLs in Markdown content.
public sealed class MarkdownLinkTransformer : ITextTransformer
Inheritance
Implements

Remarks

The MarkdownLinkTransformer class provides functionality for transforming URLs within Markdown content. It processes both inline links `[text](url "title")` and reference link definitions `[ref]: url "title"`, replacing URLs according to the provided IUrlTransformer.

This transformer is particularly useful when generating Markdown documentation where URLs need to be adjusted based on output structure or when implementing cross-references between documentation pages.

Thread Safety

All public members of the type are guaranteed to be thread-safe.

Constructors

MarkdownLinkTransformer()Initializes a new instance of the MarkdownLinkTransformer class.

Methods

Transform(TextReader, TextWriter, IUrlTransformer)Transforms Markdown content by updating URLs according to the specified URL translator.

See Also