UNPKG

@backstage/plugin-techdocs

Version:

The Backstage plugin that renders technical documentation for your components

backstage.io

backstage/backstage

14 lines (7 loc) • 686 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# TechDocs Plugin ## Getting started Set up Backstage and TechDocs by following our guide on [Getting Started](../../docs/features/techdocs/getting-started.md). ## Configuration Refer to our [configuration reference](../../docs/features/techdocs/configuration.md) for a complete listing of configuration options. ### TechDocs Storage API The default setup of TechDocs assumes that your documentation is accessed by reading a page with the format of `<storageUrl>/<entity namespace>/<entity kind>/<entity name>`. This can be configured by [implementing a new techdocs storage API](https://backstage.io/docs/features/techdocs/how-to-guides#how-to-implement-your-own-techdocs-apis).