JSPM

@kevinbds/plugin-techdocs-backend

0.13.4
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
    • 0
  • Score
    100M100P100Q18518F
  • License Apache-2.0

The Backstage backend plugin that renders technical documentation for your components

Package Exports

  • @kevinbds/plugin-techdocs-backend
  • @kevinbds/plugin-techdocs-backend/dist/index.cjs.js

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 (@kevinbds/plugin-techdocs-backend) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

techdocs-backend

This is the backend part of the techdocs plugin.

Getting Started

This backend plugin can be started in a standalone mode directly from in this package using yarn start. However, it will have limited functionality and that process is most convenient when developing the techdocs backend plugin itself.

To evaluate TechDocs and have a greater amount of functionality available, instead do:

# From your Backstage root directory
cd packages/backend
yarn start

What techdocs-backend does

This provides serving and building of documentation for any entity. To configure various storage providers and building options, see http://backstage.io/docs/features/techdocs/configuration.

The techdocs-backend re-exports the techdocs-common package which has the features to prepare, generate and publish docs. The Publishers are also used to fetch the static documentation files and render them in TechDocs.