JSPM

@backstage/plugin-techdocs

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

Package Exports

  • @backstage/plugin-techdocs

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 follow our guide on Getting Started.

Configuration

Custom Storage URL

TechDocs will try to read your documentation from the URL you have specified in the techdocs storageUrl in app-config.yml.

TechDocs Storage Api

The default setup of TechDocs assumes your documentation is accessed by reading a page with the format of <storageUrl>/<entity kind>/<entity namespace>/<entity name>. If for some reason you want to change this it can be configured by implementing a new techdocs storage API. Do this by implementing TechDocsStorage found in plugins/techdocs/src/api. Add your new API to the application in app/src/apis.ts (or replace if it's already registered as an API).