Skip to content

Commit

Permalink
Merge pull request #154 from backstage/bump-material-version
Browse files Browse the repository at this point in the history
Bumped the version of the Material theme to 9.2.7
  • Loading branch information
alexlorenzi authored Nov 21, 2023
2 parents b91a812 + eeee9d7 commit 085c94c
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 5 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
6 changes: 3 additions & 3 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# 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
# or more features that are provided by `techdocs-core`, and thus are always
# 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
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion src/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit 085c94c

Please sign in to comment.