Files
backstage/plugins/techdocs-backend
Himanshu Mishra 2165901c00 TechDocs: Generator now requires input and output directory and does not create them
The creation of temporary directories and their clean up should be handled on its own. techdocs-cli already has a fixed input output dir requirement. It makes that generator accepts these values as requirements.
2021-01-11 22:33:10 +01:00
..
2020-08-07 18:51:08 +02:00
2021-01-07 10:31:20 +00:00
2020-12-21 16:33:39 +05:30

techdocs-backend

This is the backend part of the techdocs plugin.

Getting Started

This backend plugin can be started in a standalone mode from directly in this package with 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

# in one terminal window, run this from from the very root of the Backstage project
cd packages/backend
yarn start

What techdocs-backend does

This plugin is the backend part of the techdocs plugin. It 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.