Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Material for MkDocs 9 #4628

merged 94 commits into from Jan 2, 2023

Material for MkDocs 9 #4628

merged 94 commits into from Jan 2, 2023


Copy link

@squidfunk squidfunk commented Nov 12, 2022

This PR contains all changes for the next major version of Material for MkDocs, which will be released as soon as the Carolina Reaper funding goal is hit. The biggest addition will be the new built-in search, which is finally released into the community edition. Sponsors have been using the new search for more than a year.

The following major changes are included (sponsors have been using most of them for over a year):

  • Rewrite of search plugin with support for rich previews
  • Detached search plugin implementation from MkDocs search plugin
  • Added support for search tokenizer lookahead
  • Added support for better search highlighting
  • Added support for excluding content from search
  • Added support for configurable search pipeline
  • Added native support for offline search via offline plugin
  • Omit code block line numbers from search
  • Improved stability of search plugin when using --dirtyreload
  • Removed support for prebuilding search indexes
  • Removed support for indexing only titles in search
  • Fixed detection of composition events in search interface
  • Fixed search plugin not using title set via front matter
  • Rewrite of worker communication layer

Additionally, since we're releasing a new major version, we take the opportunity to remove several deprecations and add some more feature flags to allow for more flexibility, the most important of which:

@squidfunk squidfunk linked an issue Dec 21, 2022 that may be closed by this pull request
5 tasks
@squidfunk squidfunk merged commit 23730a1 into master Jan 2, 2023
2 checks passed
@squidfunk squidfunk deleted the feature/material-v9 branch January 2, 2023 09:24
Copy link

jrappen commented Jan 2, 2023

@squidfunk FYI, you still need a git tag


Copy link
Owner Author

The branch was merged, I've not yet released it. Packing up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
None yet
4 participants