Structure
IndexPageBuilder
Builds a combined index page listing all documented modules.
struct IndexPageBuilderOverview
This type creates a landing page that provides navigation to all modules and packages documented in the output.
Topics
Structures
S
IndexPageBuilder.IndexContent
The content extracted from an INDEX.md file.
S
IndexPageBuilder.ModuleEntry
A documented module entry.
S
IndexPageBuilder.TutorialEntry
A tutorial collection entry.
Initializers
?
init(configuration:)
Creates a new index page builder.
Instance Properties
V
configuration
The configuration for page building.
Instance Methods
F
buildIndexPage(modules:tutorials:indexContent:)
Builds the combined index page HTML.
F
loadIndexContent(from:)
Loads and parses the INDEX.md file if it exists.
Type Properties
?
indexMarkdownFilename
The standard filename for the index page introduction content.
Relationships
Conforms To
See Also
Rendering
S
HTMLPageBuilder
Builds complete HTML pages from render nodes.
S
RenderContentHTMLRenderer
Renders DocC render content to HTML.
C
StaticHTMLConsumer
A consumer that writes documentation to static HTML files.