squidfunk / squidfunk/mkdocs-material

⚠️ End of life extended to May 5, 2027

Open
#8,523 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

announcement
Dominant language
Python
Stars
27.5k
Forks
4.1k
Avg merge
2h 39m
Merged PRs (30d)
1

Description

[!WARNING]

Material for MkDocs is in its final maintenance period. We have extended critical bug fixes and security updates through May 5, 2027, six months beyond the previously announced date. New feature development remains focused on Zensical.

There is no need to migrate immediately. The extension gives teams more time to evaluate Zensical, test their existing projects, and plan a controlled production transition.

Looking ahead

Zensical is our next-generation, open source static site generator, built from first principles by the team behind Material for MkDocs. It aims to remain compatible with your existing Material projects while bringing static site generation, theming, customization, and authoring into one coherent stack.

Zensical Studio is an authoring environment built on that foundation. It works with existing MkDocs projects, so you can write and preview your documentation there before migrating your site.

The Zensical stack — an integrated foundation for static site generation, theming, and customization

For the full context behind this transition, why we built Zensical and what it means for Material users, read our announcement:

Read the full announcement on our blog

Transitioning to Zensical

Zensical already supports a substantial part of the Material for MkDocs experience. These resources can help you assess when it is right for your project:

We are continuing to make the transition easier over time.

Stay in touch

[!NOTE]

Need help planning ahead?

If documentation is business-critical to your organization, get in touch to discuss Zensical, a longer transition, or support options.

Changes to the issue tracker

We will continue to welcome contributions and reports, while prioritizing work that keeps existing Material for MkDocs sites dependable during the maintenance period:

  • Bug reports: Please continue to report reproducible bugs using our bug reporting guidelines. We will prioritize security issues and defects that materially affect existing sites. Minor issues may not receive a fix.
  • Feature requests: New feature development belongs in Zensical. You are welcome to share requests, and we may use them to inform Zensical’s direction.
  • Documentation issues: Documentation corrections and improvements remain very welcome.

Contributor guide

Open the contributing guide

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.

Research direction

The issue contains an end-of-life announcement but names no repository file, test, or entry point to update. First clarify which documentation or project content this should change and define the expected published location and acceptance criteria; completion cannot be verified from the current issue alone.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.