# HtmlDocumentationExporter

Kind: Class  
Namespace: `Sisk.Documenting.Html`  
Assembly: `Sisk.Documenting.Html.dll`  
Source: https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.html

Represents a class for exporting API documentation to HTML format.

```csharp
public class HtmlDocumentationExporter : IApiDocumentationExporter
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ← 
[HtmlDocumentationExporter](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.md)

#### Implements

IApiDocumentationExporter

#### Inherited Members

[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype), 
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone), 
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring), 
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)), 
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)), 
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals), 
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode)

## Constructors

| Name | Description |
| --- | --- |
| [HtmlDocumentationExporter\(\)](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.-ctor.md#Sisk_Documenting_Html_HtmlDocumentationExporter__ctor) | Creates an new instance of the [HtmlDocumentationExporter](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.md) class. |

## Properties

| Name | Description |
| --- | --- |
| [Footer](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.Footer.md#Sisk_Documenting_Html_HtmlDocumentationExporter_Footer) | Gets or sets an optional object to append after the generated contents, right at the end of the `<main>` tag of the generated page. |
| [FormatBackToEndpoints](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.FormatBackToEndpoints.md#Sisk_Documenting_Html_HtmlDocumentationExporter_FormatBackToEndpoints) | Gets or sets the format string for the link that returns from an endpoint page to the endpoint listing. |
| [FormatEndpointHeaders](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.FormatEndpointHeaders.md#Sisk_Documenting_Html_HtmlDocumentationExporter_FormatEndpointHeaders) | Gets or sets the format string for endpoint headers. |
| [FormatEndpointParameters](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.FormatEndpointParameters.md#Sisk_Documenting_Html_HtmlDocumentationExporter_FormatEndpointParameters) | Gets or sets the format string for endpoint request parameters. |
| [FormatEndpointPathParameters](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.FormatEndpointPathParameters.md#Sisk_Documenting_Html_HtmlDocumentationExporter_FormatEndpointPathParameters) | Gets or sets the format string for endpoint path parameters. |
| [FormatEndpointQueryParameters](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.FormatEndpointQueryParameters.md#Sisk_Documenting_Html_HtmlDocumentationExporter_FormatEndpointQueryParameters) | Gets or sets the format string for endpoint query parameters. |
| [FormatEndpointRequestExamples](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.FormatEndpointRequestExamples.md#Sisk_Documenting_Html_HtmlDocumentationExporter_FormatEndpointRequestExamples) | Gets or sets the format string for endpoint request examples. |
| [FormatEndpointResponses](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.FormatEndpointResponses.md#Sisk_Documenting_Html_HtmlDocumentationExporter_FormatEndpointResponses) | Gets or sets the format string for endpoint responses. |
| [FormatMainTitleServiceVersion](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.FormatMainTitleServiceVersion.md#Sisk_Documenting_Html_HtmlDocumentationExporter_FormatMainTitleServiceVersion) | Gets or sets the format string for the main title service version. |
| [FormatNavApiReference](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.FormatNavApiReference.md#Sisk_Documenting_Html_HtmlDocumentationExporter_FormatNavApiReference) | Gets or sets the format string for the navigation section title for API Reference. |
| [FormatParameterExamples](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.FormatParameterExamples.md#Sisk_Documenting_Html_HtmlDocumentationExporter_FormatParameterExamples) | Gets or sets the heading displayed above the situational examples for a request parameter. |
| [FormatRequiredText](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.FormatRequiredText.md#Sisk_Documenting_Html_HtmlDocumentationExporter_FormatRequiredText) | Gets or sets the format string for required text. |
| [FormatShowLess](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.FormatShowLess.md#Sisk_Documenting_Html_HtmlDocumentationExporter_FormatShowLess) | Gets or sets the label of the button that collapses an expanded request or response example description. |
| [FormatShowMore](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.FormatShowMore.md#Sisk_Documenting_Html_HtmlDocumentationExporter_FormatShowMore) | Gets or sets the label of the button that expands a long request or response example description. |
| [FormatTabExample](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.FormatTabExample.md#Sisk_Documenting_Html_HtmlDocumentationExporter_FormatTabExample) | Gets or sets the format string for the "Example" tab label. |
| [FormatTabSchema](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.FormatTabSchema.md#Sisk_Documenting_Html_HtmlDocumentationExporter_FormatTabSchema) | Gets or sets the format string for the "Schema" tab label. |
| [Head](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.Head.md#Sisk_Documenting_Html_HtmlDocumentationExporter_Head) | Gets or sets an optional object to append inside the `<head>` tag of the generated page. |
| [Header](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.Header.md#Sisk_Documenting_Html_HtmlDocumentationExporter_Header) | Gets or sets an optional object to append after the main title, at the beginning of the `<main>` tag of the generated page. |
| [IncludeSidebar](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.IncludeSidebar.md#Sisk_Documenting_Html_HtmlDocumentationExporter_IncludeSidebar) | Gets or sets whether to include the sidebar navigation. Default is true. |
| [PageTitle](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.PageTitle.md#Sisk_Documenting_Html_HtmlDocumentationExporter_PageTitle) | Gets or sets the title of the HTML page. |
| [Script](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.Script.md#Sisk_Documenting_Html_HtmlDocumentationExporter_Script) | Gets or sets the JavaScript script to be included in the HTML page. |
| [Style](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.Style.md#Sisk_Documenting_Html_HtmlDocumentationExporter_Style) | Gets or sets the CSS styles of the HTML page. |

## Methods

| Name | Description |
| --- | --- |
| [CreateCodeBlock\(string, string?\)](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.CreateCodeBlock.md#Sisk_Documenting_Html_HtmlDocumentationExporter_CreateCodeBlock_System_String_System_String_) | Creates an HTML code block element from the provided code and language. |
| [CreateEndpointBadge\(RouteMethod, string?\)](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.CreateEndpointBadge.md#Sisk_Documenting_Html_HtmlDocumentationExporter_CreateEndpointBadge_Sisk_Core_Routing_RouteMethod_System_String_) | Creates an HTML badge element for an API endpoint. |
| [CreateExampleSchemaTabControl\(string?, string?, string?, string\)](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.CreateExampleSchemaTabControl.md#Sisk_Documenting_Html_HtmlDocumentationExporter_CreateExampleSchemaTabControl_System_String_System_String_System_String_System_String_) | Creates a tab control with Example and Schema tabs when both are available. If only one is available, it renders just that content without tabs. |
| [CreateParagraphs\(string?\)](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.CreateParagraphs.md#Sisk_Documenting_Html_HtmlDocumentationExporter_CreateParagraphs_System_String_) | Creates one or more HTML paragraph elements from the provided text. |
| [Ellipsis\(string?, int\)](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.Ellipsis.md#Sisk_Documenting_Html_HtmlDocumentationExporter_Ellipsis_System_String_System_Int32_) | Truncates a string to the specified size, appending an ellipsis if necessary. |
| [ExportDocumentationContent\(ApiDocumentation\)](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.ExportDocumentationContent.md#Sisk_Documenting_Html_HtmlDocumentationExporter_ExportDocumentationContent_Sisk_Documenting_ApiDocumentation_) | Exports the API documentation as HTTP content. |
| [ExportHtml\(ApiDocumentation\)](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.ExportHtml.md#Sisk_Documenting_Html_HtmlDocumentationExporter_ExportHtml_Sisk_Documenting_ApiDocumentation_) | Exports the API documentation as an HTML string. |
| [GetEndpointId\(ApiEndpoint\)](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.GetEndpointId.md#Sisk_Documenting_Html_HtmlDocumentationExporter_GetEndpointId_Sisk_Documenting_ApiEndpoint_) | Gets the unique HTML ID of an API endpoint, derived from its method and route path. |
| [GetRouteMethodHexColor\(RouteMethod\)](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.GetRouteMethodHexColor.md#Sisk_Documenting_Html_HtmlDocumentationExporter_GetRouteMethodHexColor_Sisk_Core_Routing_RouteMethod_) | Gets the hex color code associated with the specified route method. |
| [IncludePrismJs\(\)](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.IncludePrismJs.md#Sisk_Documenting_Html_HtmlDocumentationExporter_IncludePrismJs) | Includes the Prism.js syntax-highlighter library by appending its JavaScript and CSS to the current [Script](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.Script.md) and [Style](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.Style.md) properties. |
| [TransformId\(string\)](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.TransformId.md#Sisk_Documenting_Html_HtmlDocumentationExporter_TransformId_System_String_) | Transforms an unsafe ID into a safe and valid HTML ID. |
| [WriteEndpointDescription\(ApiEndpoint\)](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.WriteEndpointDescription.md#Sisk_Documenting_Html_HtmlDocumentationExporter_WriteEndpointDescription_Sisk_Documenting_ApiEndpoint_) | Writes the description of an API endpoint. |
| [WriteMainTitle\(ApiDocumentation\)](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.WriteMainTitle.md#Sisk_Documenting_Html_HtmlDocumentationExporter_WriteMainTitle_Sisk_Documenting_ApiDocumentation_) | Writes the main title of the API documentation. |
| [WriteSidebarNavigation\(ApiDocumentation\)](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.WriteSidebarNavigation.md#Sisk_Documenting_Html_HtmlDocumentationExporter_WriteSidebarNavigation_Sisk_Documenting_ApiDocumentation_) | Writes the sidebar navigation for the API documentation. |
| [WriteThemeSwitcher\(\)](https://docs.sisk-framework.org/api/Sisk.Documenting.Html.HtmlDocumentationExporter.WriteThemeSwitcher.md#Sisk_Documenting_Html_HtmlDocumentationExporter_WriteThemeSwitcher) | Writes the color theme switcher, which lets the reader choose between the system, light and dark themes. |