You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+48-28Lines changed: 48 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -149,61 +149,81 @@ We only use `material-mkdocs` as base styles because Backstage also uses the `Ma
149
149
150
150
## Changelog
151
151
152
+
### 1.5.1
153
+
154
+
- Minimum supported Python version is now 3.9
155
+
- Update dependency `mkdocs-material` to v9.5.46
156
+
- Update dependency `mkdocs-redirects` to v1.2.2
157
+
152
158
### 1.5.0
153
-
- Renamed package namespace from `src` to `techdocs_core`
154
-
- Fix small deprecation in tests (`assertEquals` -> `assertEqual`) as it was deprecated since Python 3.2 and removed in 3.12
159
+
160
+
- Renamed package namespace from `src` to `techdocs_core`
161
+
- Fix small deprecation in tests (`assertEquals` -> `assertEqual`) as it was deprecated since Python 3.2 and removed in 3.12
155
162
156
163
### 1.4.2
157
-
- Fixes an issue where individual extension configurations were being ignored if the extension was included within `pymdownx.extra`. See [#147](https://github.com/backstage/mkdocs-techdocs-core/issues/147)
164
+
165
+
- Fixes an issue where individual extension configurations were being ignored if the extension was included within `pymdownx.extra`. See [#147](https://github.com/backstage/mkdocs-techdocs-core/issues/147)
158
166
159
167
### 1.4.1
160
-
- Introduced mkdocs-redirects plugin (v`1.2.1`).
168
+
169
+
- Introduced mkdocs-redirects plugin (v`1.2.1`).
161
170
162
171
### 1.4.0
163
-
- Updated minimum mkdocs dependency from `1.5` to `1.6`
- Bumped `mkdocs-material` to `9.5.13` which adds support for card grids and grid layouts
182
+
183
+
- Bumped `mkdocs-material` to `9.5.13` which adds support for card grids and grid layouts
172
184
173
185
### 1.3.3
174
-
- Bumped `mkdocs-material` to `9.4.14` which add support for: Mermaid.js version 10.6.1, emoji extension and updated MkDocs to 1.5.3
175
-
- Added tests for `Python` version `3.11`
186
+
187
+
- Bumped `mkdocs-material` to `9.4.14` which add support for: Mermaid.js version 10.6.1, emoji extension and updated MkDocs to 1.5.3
188
+
- Added tests for `Python` version `3.11`
176
189
177
190
### 1.3.2
178
-
- Bumped `pymdown-extensions` to `10.3.1` which add material.extensions support
179
-
- Removed support for `Python` version `3.7`
191
+
192
+
- Bumped `pymdown-extensions` to `10.3.1` which add material.extensions support
193
+
- Removed support for `Python` version `3.7`
180
194
181
195
### 1.3.1
182
-
- Bumped `pygments` to `2.17.2` which includes JSX support.
196
+
197
+
- Bumped `pygments` to `2.17.2` which includes JSX support.
183
198
184
199
### 1.3
185
-
- Bumped `mkdocs-material` (and its dependencies) from `9.1.3` to `9.2.7` causing a few changes:
200
+
201
+
- Bumped `mkdocs-material` (and its dependencies) from `9.1.3` to `9.2.7` causing a few changes:
186
202
- MkDocs dependency is now `1.5`
187
-
- `theme.palette`is now hardcoded to `{}` instead of `""` which caused some issues with some Material plugins
203
+
- `theme.palette`is now hardcoded to `{}` instead of `""` which caused some issues with some Material plugins
188
204
189
205
### 1.2.3
190
-
- Bumped `pygments` to `2.16.1`, which also fixes a [vulnerability](https://github.com/advisories/GHSA-mrwq-x4v8-fh7p).
191
-
- Update dependency `plantuml-markdown` to `3.9.2`.
206
+
207
+
- Bumped `pygments` to `2.16.1`, which also fixes a [vulnerability](https://github.com/advisories/GHSA-mrwq-x4v8-fh7p).
208
+
- Update dependency `plantuml-markdown` to `3.9.2`.
192
209
193
210
### 1.2.2
194
-
- Added config override of `pymdownx.snippets` for [security](https://github.com/facelessuser/pymdown-extensions/security/advisories/GHSA-jh85-wwv9-24hv). `restrict_base_path` will always be `true`. If you currently use snippets with files outside of the directory, those files will no longer be included.
211
+
212
+
- Added config override of `pymdownx.snippets` for [security](https://github.com/facelessuser/pymdown-extensions/security/advisories/GHSA-jh85-wwv9-24hv). `restrict_base_path` will always be `true`. If you currently use snippets with files outside of the directory, those files will no longer be included.
195
213
196
214
### 1.2.1
197
-
- Use latest version of `pymdown-extensions` which contains [security fixes](https://github.com/backstage/mkdocs-techdocs-core/pull/123).
215
+
216
+
- Use latest version of `pymdown-extensions` which contains [security fixes](https://github.com/backstage/mkdocs-techdocs-core/pull/123).
198
217
199
218
### 1.2.0
200
-
- Updated `mkdocs-material` (and its dependencies) from `8.1.11` to `9.1.3` causing a few changes:
201
-
- Some `mkdocs-material` features were made opt-in v9. In order to preserve compatibility, they are now hardcoded as enabled by `mkdocs-techdocs-core`. The features are
202
-
- `navigation.footer`
203
-
- `content.action.edit`
204
-
- `theme.palette`is now hardcoded to `""` to preserve previous behavior. Without hardcoding the palette, it gets the value `default`, causing unwanted visual changes.
205
-
- Some components e.g. admonitions have a slightly different look.
206
-
- Minor color changes that can be avoided by also updating to the latest version of `@backstage/plugin-techdocs` which compensates these changes.
219
+
220
+
- Updated `mkdocs-material` (and its dependencies) from `8.1.11` to `9.1.3` causing a few changes:
221
+
- Some `mkdocs-material` features were made opt-in v9. In order to preserve compatibility, they are now hardcoded as enabled by `mkdocs-techdocs-core`. The features are
222
+
- `navigation.footer`
223
+
- `content.action.edit`
224
+
- `theme.palette`is now hardcoded to `""` to preserve previous behavior. Without hardcoding the palette, it gets the value `default`, causing unwanted visual changes.
225
+
- Some components e.g. admonitions have a slightly different look.
226
+
- Minor color changes that can be avoided by also updating to the latest version of `@backstage/plugin-techdocs` which compensates these changes.
0 commit comments