Class
StaticHTMLConsumer
A consumer that writes documentation to static HTML files.
final class StaticHTMLConsumerOverview
This type implements the ConvertOutputConsumer protocol from SwiftDocC, receiving render nodes and writing them as static HTML pages.
Topics
Initializers
?
init(outputDirectory:configuration:)
Creates a new static HTML consumer.
Instance Properties
V
configuration
The configuration for HTML generation.
V
navigationIndex
The navigation index for building the sidebar.
V
outputDirectory
The output directory for generated documentation.
Instance Methods
F
result()
Returns the generation result after all content has been consumed.
Default Implementations
Relationships
Conforms To
See Also
Rendering
S
HTMLPageBuilder
Builds complete HTML pages from render nodes.
S
RenderContentHTMLRenderer
Renders DocC render content to HTML.
S
IndexPageBuilder
Builds a combined index page listing all documented modules.