diff --git a/.changeset/fuzzy-suits-sit.md b/.changeset/fuzzy-suits-sit.md index 11cf08d8da..b62f69f8d5 100644 --- a/.changeset/fuzzy-suits-sit.md +++ b/.changeset/fuzzy-suits-sit.md @@ -2,7 +2,7 @@ '@backstage/plugin-techdocs': minor --- -Add two config values to the `page:techdocs/reader` extension that configure default layout, `withSearch` and `withHeader`. Default are unchanged to `true`. +Add two config values to the `page:techdocs/reader` extension that configure default layout, `withoutSearch` and `withoutHeader`. Default are unchanged to `false`. E.g. to disable the search and header on the Techdocs Reader Page: @@ -11,6 +11,6 @@ app: extensions: - page:techdocs/reader: config: - withSearch: false - withHeader: false + withoutSearch: true + withoutHeader: true ``` diff --git a/packages/techdocs-cli-embedded-app/app-config.yaml b/packages/techdocs-cli-embedded-app/app-config.yaml index be60d56756..09553edc8a 100644 --- a/packages/techdocs-cli-embedded-app/app-config.yaml +++ b/packages/techdocs-cli-embedded-app/app-config.yaml @@ -5,7 +5,7 @@ app: - sign-in-page:app: false - page:techdocs/reader: config: - withSearch: false + withoutSearch: true backend: baseUrl: http://localhost:3000 diff --git a/packages/techdocs-cli-embedded-app/src/App.test.tsx b/packages/techdocs-cli-embedded-app/src/App.test.tsx index 4a7eaef911..fc6d25863c 100644 --- a/packages/techdocs-cli-embedded-app/src/App.test.tsx +++ b/packages/techdocs-cli-embedded-app/src/App.test.tsx @@ -30,7 +30,7 @@ jest.mock('./config', () => ({ { 'page:techdocs/reader': { config: { - withSearch: false, + withoutSearch: true, }, }, }, diff --git a/plugins/techdocs/report-alpha.api.md b/plugins/techdocs/report-alpha.api.md index bf561c12b9..3092a010d4 100644 --- a/plugins/techdocs/report-alpha.api.md +++ b/plugins/techdocs/report-alpha.api.md @@ -308,13 +308,13 @@ const _default: OverridableFrontendPlugin< }>; 'page:techdocs/reader': OverridableExtensionDefinition<{ config: { - withSearch: boolean; - withHeader: boolean; + withoutSearch: boolean; + withoutHeader: boolean; path: string | undefined; }; configInput: { - withSearch?: boolean | undefined; - withHeader?: boolean | undefined; + withoutSearch?: boolean | undefined; + withoutHeader?: boolean | undefined; path?: string | undefined; }; output: diff --git a/plugins/techdocs/src/alpha/index.tsx b/plugins/techdocs/src/alpha/index.tsx index 64c6b8e9ad..9e63004046 100644 --- a/plugins/techdocs/src/alpha/index.tsx +++ b/plugins/techdocs/src/alpha/index.tsx @@ -158,18 +158,12 @@ const techDocsReaderPage = PageBlueprint.makeWithOverrides({ }, config: { schema: { - withSearch: z => z.boolean().default(true), - withHeader: z => z.boolean().default(true), + withoutSearch: z => z.boolean().default(false), + withoutHeader: z => z.boolean().default(false), }, }, - factory(originalFactory, { inputs, config }) { + factory(originalFactory, { apis, inputs, config }) { const addonsApi = apis.get(techdocsAddonsApiRef); - const addons = inputs.addons.map(output => { - const options = output.get(AddonBlueprint.dataRefs.addon); - const Addon = options.component; - attachTechDocsAddonComponentData(Addon, options); - return ; - }); return originalFactory({ path: '/docs/:namespace/:kind/:name', @@ -195,8 +189,8 @@ const techDocsReaderPage = PageBlueprint.makeWithOverrides({ return import('../Router').then(({ TechDocsReaderRouter }) => ( {addons}