@backstage/plugin-techdocs-module-addons-contrib

Home > @backstage/plugin-techdocs-module-addons-contrib

A plugin for contributed TechDocs Addons.

Functions

Function	Description
ExpandableNavigation()	TechDocs addon that lets you expand/collapse the TechDocs main navigation and keep the preferred state in local storage. The addon will render as a button next to the site name if the documentation has nested navigation.
LightBox()	This TechDocs addon allows users to open images in a lightbox on documentation pages, they can navigate between images if there are several on one page.
ReportIssue(props)	TechDocs addon that lets you select text and open GitHub/Gitlab issues
TextSize()	This TechDocs addon allows users to customize text size on documentation pages, they can select how much they want to increase or decrease the font size via slider or buttons.

Variables

Variable	Description
techdocsModuleAddonsContribPlugin	The TechDocs addons contrib plugin

Type Aliases

Type Alias	Description
ReportIssueProps	Props customizing the Addon.
ReportIssueTemplate	Properties for creating an issue in a remote issue tracker.
ReportIssueTemplateBuilder	A function for returning a custom issue template, given a selection of text on a TechDocs page.