@backstage/plugin-techdocs-backend
Home > @backstage/plugin-techdocs-backend
The Backstage backend plugin that renders technical documentation for your components
Classes
Class | Description |
---|---|
DefaultTechDocsCollator | A search collator responsible for gathering and transforming TechDocs documents. |
Functions
Function | Description |
---|---|
createRouter(options) | Creates a techdocs router. |
Variables
Variable | Description |
---|---|
DefaultTechDocsCollatorFactory |
Type Aliases
Type Alias | Description |
---|---|
DocsBuildStrategy | |
OutOfTheBoxDeploymentOptions | Required dependencies for running TechDocs in the "out-of-the-box" deployment configuration (prepare/generate/publish all in the Backend). |
RecommendedDeploymentOptions | Required dependencies for running TechDocs in the "recommended" deployment configuration (prepare/generate handled externally in CI/CD). |
RouterOptions | One of the two deployment configurations must be provided. |
ShouldBuildParameters | |
TechDocsCollatorFactoryOptions | |
TechDocsCollatorOptions | Options to configure the TechDocs collator |
TechDocsDocument |