Documentation

Author: squidfunk

CHANGELOG

@@ -10,12 +10,13 @@ bug fixes and security updates for Material for MkDocs for 12 months – at leas
 Read the full announcement on our blog:
 https://squidfunk.github.io/mkdocs-material/blog/2025/11/05/zensical/
 
-This release includes all features that were previously exclusively available
-as part of the Insiders edition. They are now free for everybody to use. The
-projects and typeset plugins turned out to be dead ends, which is why they
-are deprecated and not part of Material for MkDocs. The sources of those plugins
-are distributed with the project, and need to be re-enabled in pyproject.toml,
-so third party contributors can take on maintenance, if desired.
+This release includes all features that were previously exclusive to the
+Insiders edition. These features are now freely available to everyone.
+
+Note on deprecated plugins: The projects and typeset plugins are included in
+this release, but must be considered deprecated. Both plugins proved
+unsustainable to maintain and represent architectural dead ends. They are
+provided as-is without ongoing support.
 
 Changes:
 

docs/changelog/index.md

@@ -4,24 +4,27 @@
 
 ### 9.7.0 <small>November 11, 2025</small> { id="9.7.0" }
 
-⚠️ __Material for MkDocs is now in maintenance mode__
+!!! warning "Material for MkDocs is now in maintenance mode"
 
-This is the last release of Material for MkDocs that will receive new features.
-Going forward, the Material for MkDocs team focuses on [Zensical], a next-gen
-static site generator built from first principles. We will provide critical
-bug fixes and security updates for Material for MkDocs for 12 months – at least.
+ This is the last release of Material for MkDocs that will receive new features.
+ Going forward, the Material for MkDocs team focuses on [Zensical], a next-gen
+ static site generator built from first principles. We will provide critical
+ bug fixes and security updates for Material for MkDocs for 12 months – at least.
 
-[Read the full announcement on our blog]
+ [Read the full announcement on our blog]
 
-This release includes all features that were previously exclusively available
-as part of the Insiders edition. They are now free for everybody to use. The
-[projects] and [typeset] plugins turned out to be dead ends, which is why they
-are deprecated and not part of Material for MkDocs. The sources of those plugins
-are distributed with the project, and need to be re-enabled in `pyproject.toml`,
-so third party contributors can take on maintenance, if desired.
+This release includes all features that were previously exclusive to the
+Insiders edition. These features are now freely available to everyone.
+
+__Note on deprecated plugins__: The [projects] and [typeset] plugins are
+included in this release, but must be considered deprecated. Both plugins
+proved unsustainable to maintain and represent architectural dead ends. They
+are provided as-is without ongoing support.
 
 __Changes__:
 
+- Added support for projects plugin (for compat, now deprecated)
+- Added support for typeset plugin (for compat, now deprecated)
 - Added support for pinned blog posts and author profiles
 - Added support for customizing pagination for blog index pages
 - Added support for customizing blog category sort order
@@ -42,9 +45,9 @@ __Changes__:
 - Fixed #8519: Vector accents do not render when using KaTeX
 
  [Zensical]: https://zensical.org
- [Read the full announcement on our blog]: https://squidfunk.github.io/mkdocs-material/blog/2025/11/05/zensical/
- [projects]: https://squidfunk.github.io/mkdocs-material/plugins/projects/
- [typeset]: https://squidfunk.github.io/mkdocs-material/plugins/typeset/
+ [Read the full announcement on our blog]: ../blog/posts/zensical.md
+ [projects]: ../plugins/projects.md
+ [typeset]: ../plugins/typeset.md
 
 ### 9.6.23 <small>November 1, 2025</small> { id="9.6.23" }
 

docs/contributing/making-a-pull-request.md

@@ -86,27 +86,25 @@ sequenceDiagram
 ```
 
 1. The first step is that you create a fork of the Material for MkDocs
- repository, either [mkdocs-material] or [mkdocs-material-insiders]
- (only accessible to sponsors). This provides you with a repository that you
- can push changes to. Note that it is not possible to have more than one fork
- of a given repository at any point in time. So, the fork you create will be
- *the* fork you have.
+ repository. This provides you with a repository that you can push changes to.
+ Note that it is not possible to have more than one fork of a given repository
+ at any point in time. So, the fork you create will be *the* fork you have.
 
-2. Once it is made, clone it to your local machine so you can start working on
+1. Once it is made, clone it to your local machine so you can start working on
  your changes.
 
-3. All contributions should be made through a 'topic branch' with a name that
+2. All contributions should be made through a 'topic branch' with a name that
  describes the work being done. This allows you to have more than one piece
  of work in progress and, if you are working with the public version, also
  shows others clearly that the code contained is work in progress. The topic
  branch will be relatively short-lived and will disappear at the end, when
  your changes have been incorporated into the codebase.
 
-4. If you intend to make any code changes, as opposed to working on
+3. If you intend to make any code changes, as opposed to working on
  documentation only, you will need to [set up a development
  environment](#setting-up-a-development-environment).
 
-5. Next comes the iterative process of making edits, committing them to your
+4. Next comes the iterative process of making edits, committing them to your
  clone. Please commit in sensible chunks that constitute a piece of work
  instead of committing everything in one go.
 
@@ -116,23 +114,23 @@ sequenceDiagram
  reviewer in mind when committing. In particular, make sure to write
  meaningful commit messages.
 
-6. Push your work up to your fork regularly.
+5. Push your work up to your fork regularly.
 
-7. You should also keep an eye on changes in the Material for MkDocs repository
+6. You should also keep an eye on changes in the Material for MkDocs repository
  you cloned. This is especially important if you work takes a while. Please
  try and merge any concurrent changes into your fork and into your branch
  regularly. You *must* do this at least once before creating a pull request,
  so make your life easier and do it more often so as to minimize the risk of
  conflicting changes.
 
-8. Once you are happy that your changes are in a state that you can describe
+7. Once you are happy that your changes are in a state that you can describe
  them in a *draft* pull request, you should create this. Make sure to
  reference any previous discussions or issues that gave rise to your work.
  Creating a draft is a good way to get *early* feedback on your work from the
  maintainer or others. You can explicitly request reviews at points where you
  think this would be important.
 
-9. Review your work as if you were the reviewer and fix any issues with your
+8. Review your work as if you were the reviewer and fix any issues with your
  work so far. Look critically at the diffs of the files that you have changed.
  In particular, pay attention to whether the changes are as small as possible
  and whether you have follow the general coding style used in the project.
@@ -144,8 +142,6 @@ sequenceDiagram
  folder. You may also want to make sure that relevant examples from the
  [examples repository] still build fine.
 
-[mkdocs-material]: https://github.com/squidfunk/mkdocs-material
-[mkdocs-material-insiders]: https://github.com/squidfunk/mkdocs-material-insiders/
 [examples repository]: https://github.com/mkdocs-material/examples
 
 ### Finalizing
@@ -243,22 +239,13 @@ repositories on GitHub. This is so that you have a repository on GitHub that
 you can push changes to (only maintainers and collaborators have write access
 to the original repositories).
 
-Fork the [repository for the public version] if you want to make changes to
-code that is in the public version or if you want to make changes to the
-documentation. It is a good idea to change the name of the repository by
-appending `-fork` so that people who come across it know that they have found a
-temporary fork rather then the original or a permanent fork of the project.
-You may also want to add a description that clarifies what the repository is for.
+Fork the [repository] if you want to make changes to code or to the documentation.
+It is a good idea to change the name of the repository by appending `-fork` so
+that people who come across it know that they have found a temporary fork rather
+than the original or a permanent fork of the project. You may also want to add
+a description that clarifies what the repository is for.
 
-[repository for the public version]: https://github.com/squidfunk/mkdocs-material
-
-To make changes to functionality available only within the Insiders version,
-fork [the Insiders repository]. Note that the fork will be a private repository.
-Please respect the [terms of the Insiders program] and the spirit of the
-Sponsorware approach used to maintain and develop Material for MkDocs.
-
-[the Insiders repository]: https://github.com/squidfunk/mkdocs-material-insiders/
-[terms of the Insiders program]: https://squidfunk.github.io/mkdocs-material/insiders/license/#fair-use-policy
+[repository]: https://github.com/squidfunk/mkdocs-material
 
 ### Setting up a development environment
 
@@ -346,21 +333,13 @@ to build a project to serve as a test suite. It can double as documentation that
 shows how your new feature is meant to work.
 
 - Test with relevant examples from the [Material for MkDocs Examples]
- repository. Note that to build all examples in one go you need the projects
- plugin from Insiders but you can always build the examples individually
- using the public version.
+ repository.
 
 [smoke tests]: https://en.wikipedia.org/wiki/Smoke_testing_(software)
 [minimal reproduction]: https://squidfunk.github.io/mkdocs-material/guides/creating-a-reproduction/
 [Material for MkDocs Examples]: https://github.com/mkdocs-material/examples
 
-- Ideally, also test the examples in the [examples repository]. If you are
-working on the Insiders edition of Material for MkDocs, you can simply start a
-build at the top level and the [projects plugin] will build all of the examples
-for you. If you are on the public version, you will need to build each
-sub-project individually. We appreciate that this is a growing collection of
-examples and you may want to prioritize those that are most relevant to the
-functionality you change.
+- Ideally, also test the examples in the [examples repository].
 
 [examples repository]: https://github.com/mkdocs-material/examples
 [projects plugin]: https://squidfunk.github.io/mkdocs-material/plugins/projects/

docs/conventions.md

@@ -8,24 +8,12 @@ This documentation use some symbols for illustration purposes. Before you read
 on, please make sure you've made yourself familiar with the following list of
 conventions:
 
-### <!-- md:sponsors --> – Sponsors only { data-toc-label="Sponsors only" }
-
-The pumping heart symbol denotes that a specific feature or behavior is only
-available to sponsors via [Insiders]. Make sure that you have access to
-[Insiders] if you want to use the feature.
-
 ### <!-- md:version --> – Version { data-toc-label="Version" }
 
 The tag symbol in conjunction with a version number denotes when a specific
 feature or behavior was added. Make sure you're at least on this version
 if you want to use it.
 
-### <!-- md:version insiders- --> – Version (Insiders) { data-toc-label="Version (Insiders)" }
-
-The tag symbol with a heart in conjunction with a version number denotes that a
-specific feature or behavior was added to the [Insiders] version of Material for
-MkDocs.
-
 ### <!-- md:default --> – Default value { #default data-toc-label="Default value" }
 
 Some properties in `mkdocs.yml` have default values for when the author does not
@@ -89,6 +77,3 @@ added by the author.
 
 Besides plugins, there are some utilities that build on top of MkDocs in order
 to provide extended functionality, like for example support for versioning.
-
- [Insiders]: insiders/index.md
-

docs/customization.md

@@ -262,37 +262,12 @@ directly in the source of the theme and recompile it.
 
 ### Environment setup
 
-First, clone the repository for the edition you want to work on. If
-you want to clone the Insiders repository, you need to become a
-sponsor first to gain access.
+First, clone the repository:
 
- [Insiders]: insiders/index.md
-
-=== "Material for MkDocs"
-
- ```
- git clone https://github.com/squidfunk/mkdocs-material
- cd mkdocs-material
- ```
-
-=== "Insiders"
-
- You will need to have a GitHub access token [as described in the
- Insiders documentation] and make it available in the `$GH_TOKEN`
- variable.
-
- ``` sh
- git clone https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git # (1)!
- ```
-
- 1. If you are using SSH keys for authenticating with GitHub, you can
- clone Insiders with this command:
-
- ```
- git clone git@github.com:squidfunk/mkdocs-material-insiders.git
- ```
-
- [as described in the Insiders documentation]: insiders/getting-started.md#requirements
+```
+git clone https://github.com/squidfunk/mkdocs-material
+cd mkdocs-material
+```
 
 Next, create a new [Python virtual environment][venv] and
 [activate][venv-activate] it:
@@ -321,25 +296,15 @@ source venv/bin/activate
 
 Then, install all Python dependencies:
 
-=== "Material for MkDocs"
-
- ```
- pip install -e ".[recommended]"
- pip install nodeenv
- ```
-
-=== "Insiders"
-
- ```
- pip install -e ".[recommended, imaging]"
- pip install nodeenv
- ```
-
- In addition, you will need to install the `cairo` and `pngquant` libraries in your
- system, as described in the [image processing] requirements guide.
+```
+pip install -e ".[git, recommended, imaging]"
+pip install nodeenv
+```
 
- [image processing]: plugins/requirements/image-processing.md
+In addition, you will need to install the `cairo` and `pngquant` libraries in your
+system, as described in the [image processing] requirements guide.
 
+[image processing]: plugins/requirements/image-processing.md
 
 Finally, install the [Node.js] LTS version into the Python virtual environment
 and install all Node.js dependencies:

docs/enterprise-support.md

@@ -133,28 +133,13 @@ The following plugins are bundled with the Docker image:
 
  Material for MkDocs only bundles selected plugins in order to keep the size
  of the official image small. If the plugin you want to use is not included,
- you can add them easily:
+ you can add them easily. Create a `Dockerfile` and extend the official image:
 
- === "Material for MkDocs"
-
-  Create a `Dockerfile` and extend the official image:
-
-  ``` Dockerfile title="Dockerfile"
-  FROM squidfunk/mkdocs-material
-  RUN pip install mkdocs-macros-plugin
-  RUN pip install mkdocs-glightbox
-  ```
-
- === "Insiders"
-
-  Clone or fork the Insiders repository, and create a file called
-  `user-requirements.txt` in the root of the repository. Then, add the
-  plugins that should be installed to the file, e.g.:
-
-  ``` txt title="user-requirements.txt"
-  mkdocs-macros-plugin
-  mkdocs-glightbox
-  ```
+ ``` Dockerfile title="Dockerfile"
+ FROM squidfunk/mkdocs-material
+ RUN pip install mkdocs-macros-plugin
+ RUN pip install mkdocs-glightbox
+ ```
 
  Next, build the image with the following command: