From a41f4b3b63a27328a760a005d5d1cc429623f403 Mon Sep 17 00:00:00 2001 From: Alex Lorenzi Date: Wed, 15 Nov 2023 11:59:32 -0500 Subject: [PATCH 1/3] The Palette property of theme expects an object not string type. --- src/core.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/core.py b/src/core.py index 478a764..b7ee372 100644 --- a/src/core.py +++ b/src/core.py @@ -70,7 +70,7 @@ def on_config(self, config): config["theme"]["features"].append("navigation.footer") config["theme"]["features"].append("content.action.edit") - config["theme"]["palette"] = "" + config["theme"]["palette"] = {} config["theme"].static_templates.update({"techdocs_metadata.json"}) config["theme"].dirs.append(self.tmp_dir_techdocs_theme.name) From e472d2f46e9a322f9d7502e453fc09cc9784c48e Mon Sep 17 00:00:00 2001 From: Alex Lorenzi Date: Wed, 15 Nov 2023 13:46:50 -0500 Subject: [PATCH 2/3] Bumped the version of the Material theme to 9.2.7 --- requirements.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/requirements.txt b/requirements.txt index 241a415..467a647 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,7 +1,7 @@ # The following are something akin to peer dependencies. They are represented # as ranges in order to support interoperability with other mkdocs plugins or # packages that might otherwise exist in an adopter's environment. -mkdocs>=1.2.2 +mkdocs>=1.5 Markdown>=3.2,<3.4 # The following are more akin to direct dependencies. Each line represents one @@ -9,13 +9,13 @@ Markdown>=3.2,<3.4 # pinned to an exact version. Bumps should be accompanied by release notes # explaining what was added or fixed (or at least pointing to the underlying # release notes of the bumped package). -mkdocs-material==9.1.3 +mkdocs-material==9.2.7 mkdocs-monorepo-plugin==1.0.5 plantuml-markdown==3.9.2 markdown_inline_graphviz_extension==1.1.1 mdx_truly_sane_lists==1.3 pygments==2.16.1 -pymdown-extensions==10.0.1 +pymdown-extensions==10.2 # The following are temporary dependencies that are only necessary to work # around incompatible/conflicting underlying dependencies. Each dependency From eeee9d747b7b77dceaa0ab731a35ab54e568d943 Mon Sep 17 00:00:00 2001 From: Alex Lorenzi Date: Mon, 20 Nov 2023 13:21:28 -0500 Subject: [PATCH 3/3] Bumped version to 1.3 --- README.md | 5 +++++ setup.py | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ab1b705..5ff8f28 100644 --- a/README.md +++ b/README.md @@ -143,6 +143,11 @@ We only use `material-mkdocs` as base styles because Backstage also uses the `Ma ### Unreleased +### 1.3 + - Bumped `mkdocs-material` (and its dependencies) from `9.1.3` to `9.2.7` causing a few changes: + - MkDocs dependency is now `1.5` + - `theme.palette` is now hardcoded to `{}` instead of `""` which caused some issues with some Material plugins + ### 1.2.3 - Bumped `pygments` to `2.16.1`, which also fixes a [vulnerability](https://github.com/advisories/GHSA-mrwq-x4v8-fh7p). - Update dependency `plantuml-markdown` to `3.9.2`. diff --git a/setup.py b/setup.py index ae22e96..ed927f5 100644 --- a/setup.py +++ b/setup.py @@ -27,7 +27,7 @@ setup( name="mkdocs-techdocs-core", - version="1.2.3", + version="1.3", description="The core MkDocs plugin used by Backstage's TechDocs as a wrapper around " "multiple MkDocs plugins and Python Markdown extensions", long_description=long_description,