JSPM

@backstage/plugin-techdocs

0.0.0-nightly-20250622024715
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 64988
  • Score
    100M100P100Q172008F
  • License Apache-2.0

The Backstage plugin that renders technical documentation for your components

Package Exports

  • @backstage/plugin-techdocs
  • @backstage/plugin-techdocs/alpha
  • @backstage/plugin-techdocs/package.json

Readme

TechDocs Plugin

Getting started

Set up Backstage and TechDocs by following our guide on Getting Started.

Configuration

Refer to our configuration reference 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.