diff --git a/docs/features/techdocs/README.md b/docs/features/techdocs/README.md index 340c0d9396..2ac90f791b 100644 --- a/docs/features/techdocs/README.md +++ b/docs/features/techdocs/README.md @@ -92,14 +92,16 @@ Some of the following items are coming soon and some are potential ideas. ## Tech stack -| Stack | Location | -| ----------------------------------------------- | -------------------------------------------------------- | -| Frontend Plugin | [`@backstage/plugin-techdocs`][techdocs/frontend] | -| Backend Plugin | [`@backstage/plugin-techdocs-backend`][techdocs/backend] | -| CLI (for local development and generating docs) | [`@techdocs/cli`][techdocs/cli] | -| Docker Container (for generating docs) | [`techdocs-container`][techdocs/container] | +| Stack | Location | +| ----------------------------------------------- | --------------------------------------------------------------- | +| Frontend Plugin | [`@backstage/plugin-techdocs`][techdocs/frontend] | +| Frontend Plugin Library | [`@backstage/plugin-techdocs-react`][techdocs/frontend-library] | +| Backend Plugin | [`@backstage/plugin-techdocs-backend`][techdocs/backend] | +| CLI (for local development and generating docs) | [`@techdocs/cli`][techdocs/cli] | +| Docker Container (for generating docs) | [`techdocs-container`][techdocs/container] | [techdocs/frontend]: https://github.com/backstage/backstage/blob/master/plugins/techdocs +[techdocs/frontend-library]: https://github.com/backstage/backstage/blob/master/plugins/techdocs-react [techdocs/backend]: https://github.com/backstage/backstage/blob/master/plugins/techdocs-backend [techdocs/container]: https://github.com/backstage/techdocs-container [techdocs/cli]: https://github.com/backstage/techdocs-cli diff --git a/docs/features/techdocs/how-to-guides.md b/docs/features/techdocs/how-to-guides.md index 56ca2252d0..45929dfd20 100644 --- a/docs/features/techdocs/how-to-guides.md +++ b/docs/features/techdocs/how-to-guides.md @@ -162,20 +162,11 @@ The `techDocsPage` is a default techdocs reader page which lives in having to set anything up. ```tsx - - {({ techdocsMetadataValue, entityMetadataValue, entityRef, onReady }) => ( - <> - - - - - - )} - + + + + + ``` If you would like to compose your own `techDocsPage`, you can do so by replacing @@ -183,42 +174,30 @@ the children of TechDocsPage with something else. Maybe you are _just_ interested in replacing the Header: ```tsx - - {({ entityRef, onReady }) => ( - <> -
- - - - - )} - + +
+ + ``` Or maybe you want to disable the in-context search ```tsx - - {({ entityRef, onReady }) => ( - <> -
- - - - - )} - + +
+ + ``` Or maybe you want to replace the entire TechDocs Page. ```tsx - +

my own content

- + ``` ## How to migrate from TechDocs Alpha to Beta