Release notes
3.0.0 (2022-11-01)¶
- (breaking) Drop gradle 5.0-5.2 support (minimum required gradle is 5.3)
- Python plugin related changes:
- Add docker support (with raw python container by default)
- Add python requirements.txt file support
- Add cleanPython task to easily cleanup local environment
- Dev server port number is now configurable: devPort property (this required for proper docker support when non-local ip must be specified)
- mkdocs.resolveDocPath() never return null: for single version docs '.' is returned now instead of null (#41)
- Update packages:
- mkdocs 1.3.0 -> 1.4.1
- mkdocs-material 8.3.6 -> 8.5.7
- pygments 2.12.0 -> 2.13.0
- pymdown-extensions 9.4 -> 9.7
- Ignore all git errors during plugin initialization (git used to resolve repoUrl on initialization) (#45)
- Split plugin into 2 plugins to let users use plugin without custom publication implementation:
- mkdocs-build - everything without publication (and no grgit plugin activation)
- mkdocs - same as before (registers mkdocs-build plugin and configures publication tasks)
- mkdocsBuild task could now update existing versions file (even download from URL) (#31)
- To enable specify existing versions file location: mkdocs.publish.existingVersionsFile = '...'
- When target file not found new (empty) one would be created
- Ideal for incremental publishing when each publication just adds a new version to existing file (when git publication is not used)
2.4.0 (2022-06-17)¶
- Fix variables support for gradle 7.4 (#34)
- Update packages:
- mkdocs-material 8.2.8 -> 8.3.6 (drops python 3.6 support)
- pygments 2.11.2 -> 2.12.0
- pymdown-extensions 9.1 -> 9.4
2.3.0 (2022-04-02)¶
- Update packages:
- mkdocs 1.2.3 -> 1.3.0 (fixes #29: jinja2 3.1.0 support)
- mkdocs-material 8.0.2 -> 8.2.8
- pygments 2.10.0 -> 2.11.2
- mkdocs-markdownextradata-plugin 0.2.4 -> 0.2.5
2.2.0 (2021-12-08)¶
- Update packages:
- mkdocs 1.1.2 -> 1.2.3
See breaking changes:
- site_url is now required
- google_analytics option deprecated - theme specific configurations used instead (see below)
- mkdocs-material 7.0.6 -> 8.0.2
Migration notes:
- instead of google_analytics extra.analytics must be used
- replace codehilite extension with pymdownx.highlight
- to activate light/dark theme toggle (#12)
- pygments 2.8.0 -> 2.10.0
- pymdown-extensions 8.1.1 -> 9.1
- Update mkdocs.yaml generated by init task with most useful options commented
- Add support for version switcher (without mike tool usage), by generating versions.json from publish repository folders (#10)
- New option
mkdocs.publish.generateVersionsFile
could disable versions.json file generation - File generated by new mkdocsVersionsFile task which may be used instead of mkdocsBuild to test switcher
- Add aliases support (same way as in mike), declared with new option
mkdocs.publish.versionAliases
- Add
mkdocs.publish.rootRedirectTo
option to be able to configure root redirection into alias
2.1.2 (2021-12-01)¶
- Fix java 8 support, dropped due to jgit 6 transitive dependency (#13)
2.1.1 (2021-03-18)¶
- Fix variables support ignore 'docs_dir' configuration from mkdocs.yml (#8)
2.1.0 (2021-03-17)¶
- Support python installed from Windows Store (use-python-plugin 2.3.0)
- Update packages:
- mkdocs 1.1 -> 1.1.2
- mkdocs-material 4.6.3 -> 7.0.6
- pygments 2.6.1 -> 2.8.0
- pymdown-extensions 6.3.0 -> 8.1.1
- Optional variables support for all mkdocs tasks: there is no (and not planned) native support for
variables in mkdocs, but often it is very handful. It is only possible to have it with a plugin. (#7)
- Added mkdocs-markdownextradata-plugin 0.2.4 as installed module (no harm, you must active it manually!)
- Added mkdocs.extras configuration option: map to declare additional variables
- When extra variables declared, plugin would generate a special file, containing all declared variables, which markdownextradata plugin would recognize and use automatically.
- Variables must be used with 'gradle' prefix: {{ gradle.declared_var_name }}
WARNING: there were some scheme changes in mkdocs-material. Most likely you may face social links change:
Before: social: - type: github link: https://github.com/xvik
After: social: - icon: fontawesome/brands/github link: https://github.com/xvik
See mkdocs-material upgrade guide for details
2.0.1 (2020-04-06)¶
- Fix relative virtualenv paths support (don't rely on gradle work dir) (#5)
2.0.0 (2020-03-13)¶
- (breaking) Drop java 7 support
- (breaking) Drop gradle 4 support
- Fix jgit dependency conflict (#4) (plugin now use jgit 5)
- Update packages:
- mkdocs 1.0.4 -> 1.1
- mkdocs-material 3.0.4 -> 4.6.3
- pygments 2.2.0 -> 2.6.1
- pymdown-extensions 6.0.0 -> 6.3.0
- Use gradle tasks configuration avoidance for lazy tasks initialization (no init when tasks not needed)
1.1.0 (2018-10-14)¶
- Default template's mkdocs.yml changes:
- fixed
edit_uri
(missed "/docs" ending) pages
changed tonav
- change parameters syntax in
markdown_extensions
section
- fixed
- Fix documentation in sub module support (use-python plugin 1.2.0)
- Support Mkdocks 1.0:
- Update default mkdocs 0.17.3 -> 1.0.4
- Update default mkdocs-material 2.7.2 -> 3.0.4
- Update default pymdown-extensions 4.9.2 -> 6.0.0
Mkdocs 1.0 migration notes (for existing docs):
- Rename
pages
section intonav
- Make sure
site_url
set correctly (otherwise sitemap will contain None instead of urls) - Change
markdown_extensions
section from usingsomething(arg=val)
syntax into:
markdown_extensions:
- admonition
- codehilite:
guess_lang: false
- footnotes
- meta
- toc:
permalink: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.smartsymbols
- pymdownx.superfences
1.0.1 (2018-04-23)¶
- Fix pip 10 compatibility (use-python plugin 1.0.2)
- Update default mkdocs 0.17.2 -> 0.17.3
- Update default mkdocs-material 2.2.1 -> 2.7.2
- Update default pymdown-extensions 4.6 -> 4.9.2
1.0.0 (2017-12-30)¶
- Initial release