Sisk

Class

LlmsApiExporter

Namespace
Sisk.Documenting.Exporters
Assembly
Sisk.Documenting.dll

Exports API documentation in a simple markdown format that can be easily rendered by LLMs or other tools.

C#
public sealed class LlmsApiExporter : IApiDocumentationExporter

Inheritance #

object ← LlmsApiExporter

Implements #

IApiDocumentationExporter

Inherited Members #

object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Constructors #

NameDescription
LlmsApiExporter()Initializes a new instance of the LlmsApiExporter class.
LlmsApiExporter(string?)Initializes a new instance of the LlmsApiExporter class with the specified hostname.
LlmsApiExporter(string?, string)Initializes a new instance of the LlmsApiExporter class with the specified hostname and header text.
LlmsApiExporter(string?, string?, string?)

Properties #

NameDescription
FooterText
HeaderTextGets or sets the header text to be displayed at the beginning of the exported documentation.
HostnameGets or sets the hostname to be used in generated endpoint URLs. If not set, the exporter will attempt to use the Host header from the current HTTP request, or fall back to relative URLs if no Host information is available.

Methods #

NameDescription
ExportDocumentationContent(ApiDocumentation)Exports the specified API documentation content.

Type to search the documentation and the API reference.