JSPM

@backstage/plugin-techdocs

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

The Backstage plugin that renders technical documentation for your components

Package Exports

  • @backstage/plugin-techdocs
  • @backstage/plugin-techdocs/dist/index.esm.js
  • @backstage/plugin-techdocs/package.json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@backstage/plugin-techdocs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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 kind>/<entity namespace>/<entity name>. This can be configured by implementing a new techdocs storage API.