Jussi Hallila
30ed662a35
* Implement in-context search bar for tech docs * Add in-context search functionality to tech docs * Use the existing backend search functionality with tech docs specific filters * Use material-ui autocomplete to display 10 first search results * Add tests Signed-off-by: Jussi Hallila <jussi@hallila.com> * Remove context and replace it with `withSearch` prop. Signed-off-by: Jussi Hallila <jussi@hallila.com> * Bump search-common devp to latest Signed-off-by: Jussi Hallila <jussi@hallila.com> * Rename types file to not conflict with hardcoded types.d.ts. Signed-off-by: Jussi Hallila <jussi@hallila.com>
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.