From 38e0eeb41a335709d3d998493b12972406d5c50c Mon Sep 17 00:00:00 2001 From: Morgan Bentell Date: Wed, 22 Mar 2023 18:34:20 +0100 Subject: [PATCH 1/3] color tweaks to handle changes in mkdocs-material v9 Signed-off-by: Morgan Bentell --- .changeset/hungry-pianos-unite.md | 5 +++++ plugins/techdocs-node/src/stages/generate/techdocs.ts | 2 +- .../src/reader/transformers/copyToClipboard.tsx | 10 +++++++--- .../src/reader/transformers/styles/rules/layout.ts | 5 +++++ 4 files changed, 18 insertions(+), 4 deletions(-) create mode 100644 .changeset/hungry-pianos-unite.md diff --git a/.changeset/hungry-pianos-unite.md b/.changeset/hungry-pianos-unite.md new file mode 100644 index 0000000000..c762b9c2a3 --- /dev/null +++ b/.changeset/hungry-pianos-unite.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-techdocs': patch +--- + +Minor visual tweaks in response to changes in mkdocs-material v9 diff --git a/plugins/techdocs-node/src/stages/generate/techdocs.ts b/plugins/techdocs-node/src/stages/generate/techdocs.ts index 2f88e1a8ad..d2ad0021be 100644 --- a/plugins/techdocs-node/src/stages/generate/techdocs.ts +++ b/plugins/techdocs-node/src/stages/generate/techdocs.ts @@ -53,7 +53,7 @@ export class TechdocsGenerator implements GeneratorBase { * The default docker image (and version) used to generate content. Public * and static so that techdocs-node consumers can use the same version. */ - public static readonly defaultDockerImage = 'spotify/techdocs:v1.1.0'; + public static readonly defaultDockerImage = 'spotify/techdocs:v1.2.0'; private readonly logger: Logger; private readonly containerRunner?: ContainerRunner; private readonly options: GeneratorConfig; diff --git a/plugins/techdocs/src/reader/transformers/copyToClipboard.tsx b/plugins/techdocs/src/reader/transformers/copyToClipboard.tsx index 422bbb10ce..28a6c789b6 100644 --- a/plugins/techdocs/src/reader/transformers/copyToClipboard.tsx +++ b/plugins/techdocs/src/reader/transformers/copyToClipboard.tsx @@ -23,7 +23,7 @@ import { SvgIcon, Tooltip, } from '@material-ui/core'; -import Button from '@material-ui/core/Button'; +import IconButton from '@material-ui/core/IconButton'; import type { Transformer } from './transformer'; import useCopyToClipboard from 'react-use/lib/useCopyToClipboard'; @@ -69,9 +69,13 @@ const CopyToClipboardButton = ({ text }: CopyToClipboardButtonProps) => { onClose={handleClose} leaveDelay={1000} > - + ); }; diff --git a/plugins/techdocs/src/reader/transformers/styles/rules/layout.ts b/plugins/techdocs/src/reader/transformers/styles/rules/layout.ts index 979a616f01..c5e69e6084 100644 --- a/plugins/techdocs/src/reader/transformers/styles/rules/layout.ts +++ b/plugins/techdocs/src/reader/transformers/styles/rules/layout.ts @@ -21,6 +21,11 @@ const SIDEBAR_WIDTH = '224px'; export default ({ theme, sidebar }: RuleOptions) => ` /*================== Layout ==================*/ +/* mkdocs material v9 compat */ +.md-nav__title { + color: var(--md-default-fg-color); +} + .md-grid { max-width: 100%; margin: 0; From 6c809d1a41c63632258132ac8ad9d1bb5d44d897 Mon Sep 17 00:00:00 2001 From: Morgan Bentell Date: Wed, 22 Mar 2023 18:43:12 +0100 Subject: [PATCH 2/3] update changeset Signed-off-by: Morgan Bentell --- .changeset/forty-gorillas-help.md | 6 ++++++ .changeset/hungry-pianos-unite.md | 5 ----- 2 files changed, 6 insertions(+), 5 deletions(-) create mode 100644 .changeset/forty-gorillas-help.md delete mode 100644 .changeset/hungry-pianos-unite.md diff --git a/.changeset/forty-gorillas-help.md b/.changeset/forty-gorillas-help.md new file mode 100644 index 0000000000..ecad212aee --- /dev/null +++ b/.changeset/forty-gorillas-help.md @@ -0,0 +1,6 @@ +--- +'@backstage/plugin-techdocs-node': patch +'@backstage/plugin-techdocs': patch +--- + +Minor visual tweaks to adapt to changes in mkdocs-material v9 diff --git a/.changeset/hungry-pianos-unite.md b/.changeset/hungry-pianos-unite.md deleted file mode 100644 index c762b9c2a3..0000000000 --- a/.changeset/hungry-pianos-unite.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@backstage/plugin-techdocs': patch ---- - -Minor visual tweaks in response to changes in mkdocs-material v9 From eef59fe416b5c0aaa3d73fc9b5d3bfe14299de54 Mon Sep 17 00:00:00 2001 From: Morgan Bentell Date: Thu, 23 Mar 2023 10:49:45 +0100 Subject: [PATCH 3/3] do default techdocs docker image version in a separate PR Signed-off-by: Morgan Bentell --- .changeset/forty-gorillas-help.md | 1 - plugins/techdocs-node/src/stages/generate/techdocs.ts | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/.changeset/forty-gorillas-help.md b/.changeset/forty-gorillas-help.md index ecad212aee..3f185525a2 100644 --- a/.changeset/forty-gorillas-help.md +++ b/.changeset/forty-gorillas-help.md @@ -1,5 +1,4 @@ --- -'@backstage/plugin-techdocs-node': patch '@backstage/plugin-techdocs': patch --- diff --git a/plugins/techdocs-node/src/stages/generate/techdocs.ts b/plugins/techdocs-node/src/stages/generate/techdocs.ts index d2ad0021be..2f88e1a8ad 100644 --- a/plugins/techdocs-node/src/stages/generate/techdocs.ts +++ b/plugins/techdocs-node/src/stages/generate/techdocs.ts @@ -53,7 +53,7 @@ export class TechdocsGenerator implements GeneratorBase { * The default docker image (and version) used to generate content. Public * and static so that techdocs-node consumers can use the same version. */ - public static readonly defaultDockerImage = 'spotify/techdocs:v1.2.0'; + public static readonly defaultDockerImage = 'spotify/techdocs:v1.1.0'; private readonly logger: Logger; private readonly containerRunner?: ContainerRunner; private readonly options: GeneratorConfig;