Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 29 additions & 3 deletions docs/about/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,45 @@ You can determine your currently installed version using `properdocs --version`:

```console
$ properdocs --version
properdocs, version 1.5.0 from /path/to/properdocs (Python 3.10)
properdocs, version 1.6.5 from /path/to/properdocs (Python 3.13)
```

## Maintenance team
## Version 1.6.5 (2026-03-15)

The current and past members of the ProperDocs team.
This is the first version of ProperDocs 🎉

These are the changes compared to MkDocs 1.6.1:

* The name is changed from "MkDocs" to "ProperDocs". The installation name and the executable are `properdocs` (#12)

* Support running all `mkdocs.themes` and `mkdocs.plugins` entrypoints *in addition to* all `properdocs.themes` and `properdocs.plugins` entrypoints (#15)

* Pick up configuration from `properdocs.yml` configuration files, with a fallback to `mkdocs.yml` (#27)

* Remove all built-in themes - there is no longer any theme installed by default (#24)

* Fix livereload not being enabled by default for `mkdocs serve` - since `click>8.2.1` (#14)

* Allow plugins to declare their support of ProperDocs and show a warning message in case they're being run from MkDocs (#21)

* Drop support for Python 3.8, officially support Python 3.14 (#17)

And other small improvements; see [commit log](https://github.com/properdocs/properdocs/compare/2862536793b3c67d9d83c33e0dd6d50a791928f8...v1.6.5).

---

## Past releases of MkDocs

Thanks to all the past maintainers of MkDocs!

* [@tomchristie](https://github.com/tomchristie/)
* [@d0ugal](https://github.com/d0ugal/)
* [@waylan](https://github.com/waylan/)
* [@oprypin](https://github.com/oprypin/)
* [@ultrabug](https://github.com/ultrabug/)

The versions below are versions of MkDocs, just for reference.

## Version 1.6.1 (2024-08-30)

### Fixed
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '1.6.1'
__version__ = '1.6.5'
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '1.6.1'
__version__ = '1.6.5'
2 changes: 1 addition & 1 deletion properdocs/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@


# For acceptable version formats, see https://www.python.org/dev/peps/pep-0440/
__version__ = '1.6.1'
__version__ = '1.6.5'
2 changes: 1 addition & 1 deletion properdocs/replacement_warning.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
To avoid these risks, switch to *ProperDocs*, a continuation of MkDocs 1.x and a drop-in replacement that supports your current MkDocs setup.
Simply install it with `pip install properdocs` and build your site with `properdocs build` instead of the MkDocs equivalents.

For more info visit https://github.com/ProperDocs/properdocs/discussions/123 and https://properdocs.org/
For more info visit https://github.com/ProperDocs/properdocs/discussions/33 and https://properdocs.org/

(This warning was initiated by one of the plugins that you depend on.)

Expand Down
Loading