TauferLab / TauferLab/GEOtiled

Migrate from mkdocs

Open
#12 0 comments 0 reactions 1 assignee View on GitHub

@ReaganSanz is already working on this.

Since Sep 3, 2026.

documentation enhancement
Dominant language
Jupyter Notebook
Stars
3
Forks
1
PR merge metrics
No merged PRs in 30d

Description

The current documentation was built using Material for mkdocs since the maintainer has announced that they will be moving on from the mkdocs dependency. Builds now have an error message:


 │  ⚠  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/

We need to evaluate new options to migrate and report on the best one. Potential options:

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.