@backstage/plugin-techdocs-backend
Advanced tools
The Backstage backend plugin that renders technical documentation for your components
This is the backend part of the techdocs plugin.
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
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-node 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.
FAQs
The Backstage backend plugin that renders technical documentation for your components
The npm package @backstage/plugin-techdocs-backend receives a total of 38,883 weekly downloads. As such, @backstage/plugin-techdocs-backend popularity was classified as popular.
We found that @backstage/plugin-techdocs-backend demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.