Port Docs to Properdocs or Zensical
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4
- Forks
- 1
- Avg merge
- 2d 5h
- Merged PRs (30d)
- 3
Description
`mkdocs` is no longer being maintained and the 2.0 version that's coming out is going to remove plugin functionality. It'd be a good idea to port to a different documentation generator that has active support.
Properdocs is a continuation of mkdocs that might be easy to switch to.
Another option is Zensical from the Material for Mkdocs team.
Here is the full warning message displayed by `mkdocs-material`:
```
│ ⚠ Warning from the Material for MkDocs team
│
│ MkDocs 2.0, the underlying framework of Material for MkDocs,
│ will introduce backward-incompatible changes, including:
│
│ × All plugins will stop working – the plugin system has been removed
│ × All theme overrides will break – the theming system has been rewritten
│ × No migration path exists – existing projects cannot be upgraded
│ × Closed contribution model – community members can't report bugs
│ × Currently unlicensed – unsuitable for production use
│
│ Our full analysis:
│
│ https://squidfunk.github.io/mkdocs-material/blog/2026/02/18/mkdocs-2.0/
----------------------------------------------------------------
WARNING: MkDocs may break support for all existing plugins and themes soon!
The owner of MkDocs has completely abandoned maintenance of the project, and instead is planning to publish a "version 2" which will not
support any existing themes, plugins or even your configuration files. This v2 may eventually replace what you download with `pip install
mkdocs`, suddenly breaking the build of your existing site.
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.
Alternatively, to just skip this warning in the future, you can set the environment variable `DISABLE_MKDOCS_2_WARNING=true`.
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.)
```
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the repository's existing MkDocs configuration and documentation build entry point, then compare ProperDocs and Zensical against the current setup. Confirm which option preserves the project's plugins, theme, and configuration before choosing a migration path. Done means the documentation builds successfully with the selected generator and existing behavior is retained.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100