Documentation Components
Documentation and API Reference templates support a growing ecosystem of components that can be used within the sections of the template itself.
When customization the default layout, it is the responsibility of the administrator to configure each component in each section correctly to optimize performance and design. In this article, we will outline which product components are available and their configuration options.
API Documentation Sidebar
The API Documentation Sidebar is a dynamic component that is responsible for rendering a Documentation navigation for the parent Product.
Configuration Options:
Expand / Collapse Icon Indicators - optionally choose which icons to use for navigation items that have child links. Defaults to +/-.
Menu Style - choose which design to use for the sidebar navigation.
Recommend Section:
Left / Right Sidebars
Variant 1
Variant 2
Variant 3
The navigation within the menu is generated by associating Documentation content on the Product level. After Documentation has been created, edit the Product you wish to associate the Documentation with and click the Documentation tab. The Documentation can be referenced here, including a customizable URL slug that will handle routing in the UI.
Basic Documentation Sidebar
API Reference Specification
Mosaic macros cannot be exported to this format.
The API Reference Specification structural component is used to render Open API Specifications for an API Reference.
API Reference Specification component is only supported by the API Reference content type.
Recommend Section:
Fullwidth Section
Main Content Section
Configuration Options:
Rendering Library: Specify the rendering library used to render the Open API Specification. Out of box, Apiboost offers two rendering frameworks:
RapiDocs (default)
Contact us to integrate with additional frameworks!
Breadcrumbs
The Breadcrumbs component is a generic component that will calculate the path based on the Parent Product and the name of the Documentation.
Page Components
The Page Components field should be added to the content section of the template in order to render the components added directly on the Documentation. There are no configurations for this field information added directly to the individual Documentation content items.
This component is only supported on Documentation content.