From 52419be1169f00417c267801775ba98c2299e601 Mon Sep 17 00:00:00 2001 From: Camila Belo Date: Thu, 5 May 2022 10:40:48 +0200 Subject: [PATCH] chore(techdocs): add changeset files Signed-off-by: Camila Belo --- .changeset/dull-waves-marry.md | 5 +++++ .changeset/nice-parrots-lie.md | 17 +++++++++++++++++ .changeset/small-eggs-guess.md | 34 ++++++++++++++++++++++++++++++++++ 3 files changed, 56 insertions(+) create mode 100644 .changeset/dull-waves-marry.md create mode 100644 .changeset/nice-parrots-lie.md create mode 100644 .changeset/small-eggs-guess.md diff --git a/.changeset/dull-waves-marry.md b/.changeset/dull-waves-marry.md new file mode 100644 index 0000000000..22d33238b4 --- /dev/null +++ b/.changeset/dull-waves-marry.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-techdocs': patch +--- + +Create a menu in the sub header of documentation pages, it is responsible for rendering TechDocs addons that allow users to customize their reading experience. diff --git a/.changeset/nice-parrots-lie.md b/.changeset/nice-parrots-lie.md new file mode 100644 index 0000000000..2a917b89f3 --- /dev/null +++ b/.changeset/nice-parrots-lie.md @@ -0,0 +1,17 @@ +--- +'@backstage/plugin-techdocs-react': patch +--- + +Create a new addon location called "Settings", it is designed for addons that allow users to customize the reading experience in documentation pages. + +Usage example: + +```tsx +const TextSize = techdocsModuleAddonsContribPlugin.provide( + createTechDocsAddonExtension({ + name: 'TextSize', + location: TechDocsAddonLocations.Settings, + component: TextSizeAddon, + }), +); +``` diff --git a/.changeset/small-eggs-guess.md b/.changeset/small-eggs-guess.md new file mode 100644 index 0000000000..4738a8775a --- /dev/null +++ b/.changeset/small-eggs-guess.md @@ -0,0 +1,34 @@ +--- +'@backstage/plugin-techdocs-module-addons-contrib': patch +--- + +Create a TechDocs `` addon that allows users to set a font size in the browser's local storage for the text of documentation pages. + +Here's an example on how to use it in a Backstage app: + +```diff +import { + DefaultTechDocsHome, + TechDocsIndexPage, + TechDocsReaderPage, +} from '@backstage/plugin-techdocs'; +import { TechDocsAddons } from '@backstage/plugin-techdocs-react/alpha'; ++import { TextSize } from '@backstage/plugin-techdocs-module-addons-contrib'; + +const AppRoutes = () => { + + // other plugin routes + }> + + + } + > + ++ + + + ; +}; +```