Structure
RenderIndex
A navigation index of the content in a DocC archive, optimized for rendering.
struct RenderIndex
Discussion
The structure of this data is determined by the topic groups authored in the processed documentation content.
This is an alternative representation of the data that is also handled by the NavigatorIndex in a NavigatorTree. This index is specifically designed to be emitted to disk as JSON file and implements the RenderIndex JSON spec.
An OpenAPI specification for RenderIndex is available in the repo at Sources/SwiftDocC/SwiftDocC.docc/Resources/RenderIndex.spec.json.
Topics
Structures
Initializers
Instance Properties
Instance Methods
Type Properties