Skip to content
CAI
Software that uses CAICheck a score

squidfunk/mkdocs-material

49.3

Weak · 16 November 2026

33.5k

lines of production code

Python

with TypeScript

5

measurements over time

CAI band scale
CAI trend line
CAI lens gauges

What this system is

Features

Users can now integrate Google Analytics 4 by configuring the provider and property in the site settings. The new implementation automatically tracks page views, search queries, and user feedback interactions. It also respects user consent preferences, ensuring analytics are only initialized if consent is granted.

src/overrides/assets/javascripts, src/templates/partials/integrations · high confidence

Added TypeScript type definitions for Lunr

Added a new TypeScript declaration file (index.d.ts) for the Lunr search library, exposing types for the index, query builder, parser, lexer, and multi-language support. This enables better type checking and IntelliSense for developers using Lunr within the project.

typings/lunr · high confidence

Added TypeScript typings for Google Fonts

The file previously defining article typography styles has been replaced with a TypeScript declaration file that exposes the \google-fonts-complete\ module. This change allows the application to import and use Google Fonts with proper type checking in TypeScript projects.

typings/google-fonts · high confidence

Added experimental Group plugin for conditional plugin loading

An experimental Group plugin is now available, allowing users to conditionally load other plugins based on configuration. The plugin supports multiple instances and enables grouping plugins that should only be active when the group is explicitly enabled. It handles plugin initialization and method ordering within the group, ensuring correct execution order among grouped plugins while integrating with MkDocs' existing plugin lifecycle.

material/plugins/group, src/plugins/group · high confidence

Added global type declarations for runtime observables and storage helpers

A new TypeScript declaration file (typings/\/index.d.ts) has been added to define global types for the application's runtime environment. This includes declarations for RxJS observables and subjects that track state such as keyboard input, viewport dimensions, media queries (tablet, screen, print), alerts, navigation progress, and component instances. It also exposes global helper functions for computing hashes and interacting with browser storage (\\_md\get, \\_md\_set), as well as the standard Google Analytics function (ga), ensuring type safety for these globally available APIs.

typings/\ · high confidence_

The icon search component now supports filtering results by category. Users can select between viewing all items, icons only, or emojis only via a new selection control, which updates the search results in real time.

src/overrides/assets/javascripts/components/iconsearch/\ · high confidence_

Added platform-specific Cairo library lookup scripts

New diagnostic scripts have been added to the includes/debug directory to help troubleshoot Cairo library loading issues on Linux, macOS, and Windows. These scripts inspect the environment and system paths to identify where the Cairo shared library (libcairo) is located or why it might not be found, printing the resolved paths and the list of files the FFI layer will attempt to load. A corresponding documentation file (mkdocs.md) has also been added to support the project's documentation build process.

includes · high confidence

Automated translation status and documentation shortcodes

The documentation build process now includes a new hook that automatically generates a language overview section in the setup guide, displaying available translations, missing keys, and direct links to file GitHub issues for updates. Additionally, a new shortcode system allows authors to insert dynamic badges into documentation pages for versions, features, plugins, extensions, and other metadata using simple comment-based syntax.

material/overrides/hooks · high confidence

Configurable text for code block copying

The clipboard integration now supports copying custom text for code blocks via the \data-copy\ attribute, in addition to the existing \data-clipboard-text\ and \data-clipboard-target\ mechanisms. When a code block has \data-copy\ set, that specific content is copied instead of the element's inner text, and trailing whitespace is automatically trimmed from the copied content.

src/templates/assets/javascripts/integrations/clipboard · high confidence

Introduction of the Blog plugin

The blog plugin is now available, providing a dedicated system for managing blog posts with features including pagination, categories, archives, and author profiles. It supports configurable URL formats, slugification, and draft handling, allowing users to structure and navigate their blog content effectively within MkDocs.

src/plugins/blog · high confidence

New JavaScript template rendering functions for UI components

The templates directory now includes new TypeScript/JSX modules that provide dedicated rendering functions for key interface elements: search results (including tags and missing terms), version selectors (supporting hidden versions and aliases), annotations, tooltips, clipboard buttons, code block navigation, tabbed controls, tables, and source facts. These functions replace or supplement previous inline rendering logic, centralizing the structure of these UI parts.

src/templates/assets/javascripts/templates · high confidence

New JavaScript utility modules and polyfills added

The repository now includes new JavaScript source files that provide core utilities and compatibility layers for the frontend. This adds a polyfill module implementing \Object.entries\, \Object.values\, \Element.scrollTo\, and \Element.replaceWith\ for older browsers, a JSX-like factory function (\h\) for creating DOM elements, a number rounding utility for displaying repository statistics, and an entry point for the search worker. These changes introduce new client-side capabilities and infrastructure rather than modifying existing behavior.

(repo-wide) · high confidence

New Meta plugin and Tag rendering infrastructure

This change introduces the Meta plugin, which allows authors to define default metadata in \.meta.yml\ files within the docs directory that are automatically merged into pages (with page-level metadata taking precedence), and adds the underlying infrastructure for tag-based listings. This includes a new \Renderer\ class for resolving Jinja templates from \fragments/tags\, default HTML templates for rendering tag badges and listing pages, and a reusable \Filter\ utility with configuration for include/exclude patterns to control file inclusion.

(repo-wide) · high confidence

New Optimize plugin for automated image compression

The new Optimize plugin automatically compresses PNG and JPEG images during the build process to reduce site size. It supports configurable quality settings, caching to speed up incremental builds, and concurrent processing for faster builds. Users can enable or disable specific optimizations, define inclusion/exclusion patterns, and view a summary of space savings in the build output.

material/plugins/optimize · high confidence

New Optimize plugin for image compression

The new Optimize plugin automatically compresses PNG and JPEG images during the build process to reduce site size. It supports configurable concurrency, caching of optimized assets, and fine-grained control over optimization quality and file inclusion/exclusion patterns, providing users with a summary of space savings after each build.

src/plugins/optimize · high confidence

New Projects and Typeset plugins for multi-site and headline management

This release introduces two new MkDocs plugins. The Projects plugin enables the concurrent, topologically-ordered building of multiple nested or adjacent MkDocs sites from a single root, featuring a process-pool builder for thread-safe isolation, a file watcher for live-reload support, and configuration options for caching, logging, and media hoisting. The Typeset plugin automatically manages page titles and headline anchors by extracting metadata and cleaning up HTML anchor links to prevent invalid nesting.

(repo-wide) · high confidence

New SCSS utilities for responsive breakpoints and unit conversion

Added \\_break.scss\ and \\_convert.scss\ to the utilities folder. The new breakpoint utilities provide mixins for device-specific media queries (mobile, tablet, screen) and orientation/aspect-ratio checks, allowing for more granular responsive styling. The conversion utilities add functions to transform HEX colors to HSL, handle RGBA transparency, and convert pixel font sizes to em or rem units with configurable bases.

src/templates/assets/stylesheets/utilities · high confidence

New blog plugin with author profiles, categories, and pagination

The blog plugin has been rewritten to provide a comprehensive blogging experience within MkDocs. Users can now define and link authors via a dedicated \.authors.yml\ file, organize posts into sortable categories, and enable paginated views for posts, archives, and author profiles. The plugin supports configurable URL slugs, date formatting, and draft handling, ensuring consistent navigation and correct pagination links even when directory URLs are disabled.

material/plugins/blog · high confidence

New component stylesheets for core UI elements

Added SCSS files for the site's foundational UI components, including author avatars, announcement banners, base layout grids, code block copy buttons, consent overlays, content areas, dialogs, feedback widgets, footer navigation, form controls, sticky headers, metadata, primary navigation, pagination, and breadcrumb paths.

src/templates/assets/stylesheets/main/components · high confidence

New documentation hooks for badges and translation management

Added new hook files in \src/overrides/hooks\ to enhance documentation rendering. \shortcodes.py\ introduces a system for processing custom markdown comments (e.g., \\<!-- md:version(...) --\>\) into styled badges for versions, features, plugins, and other metadata. \translations.py\ adds logic to automatically detect missing translations in language files and render a language overview with links to contribute, while \translations.html\ provides the Jinja2 templates for displaying these language flags and names.

src/overrides/hooks · high confidence

New icon search query component with analytics tracking

Added a new \mountIconSearchQuery\ component that manages the icon search input state (value and focus) using RxJS observables. This component now automatically tracks search queries in Google Analytics when the user blurs the input field, sending a pageview event with the query parameter appended to the current path.

src/overrides/assets/javascripts/components/iconsearch/query · high confidence

New icon search result rendering component

Added a new template component for rendering individual results in the icon search interface. This component displays the icon image and a clickable button that copies the icon's shortcode (with or without surrounding colons depending on context) to the clipboard, while highlighting matching text in the search query.

src/overrides/assets/javascripts/templates/iconsearch · high confidence

New info plugin for bug report reproduction

A new info plugin has been added to help users create reproducible bug reports. It automatically generates a self-contained ZIP archive of the project files, validates that all paths are within the current working directory, checks for the latest version, and excludes common non-essential files like cache directories and IDE settings. The plugin is disabled by default during local serving to avoid interference but can be enabled via configuration.

material/plugins/info, src/plugins/info · high confidence

New landing page and custom asset overrides

The documentation now includes a dedicated landing page (home.html) that replaces the default index with a hero section featuring an illustration, a call-to-action for the quick start guide, and a link to Insiders. Additionally, the main layout (main.html) has been updated to inject custom CSS and JavaScript assets, and the announcement bar now promotes updates on both Mastodon and X (formerly Twitter).

material/overrides · high confidence

New landing page and icon search component

The product now includes a dedicated landing page template (home.html) that features a hero section with a static header, specific layout adjustments, and links to the quick start and Insiders pages. Additionally, a new icon search component has been added to the JavaScript assets, exposing modules for querying and displaying icon search results.

src/overrides · high confidence

New sponsorship component with live data integration

A new sponsorship component has been added to the JavaScript assets, introducing a \mountSponsorship\ function that fetches sponsorship data from a remote API endpoint. This component dynamically updates the displayed count of sponsors and the total monthly contribution amount, while rendering a list of public sponsors and a combined count for private sponsors. The implementation utilizes RxJS for handling asynchronous data streams and integrates with existing template functions to render sponsor details.

src/overrides/assets/javascripts/components/sponsorship · high confidence

New sponsorship rendering components for public and private sponsors

The sponsorship template area now includes a new index.tsx file that exports functions to render public sponsors (displaying their image and name as a link) and private sponsors (showing a count link). This refactoring introduces specific UI components for displaying sponsorship information in the documentation theme.

src/overrides/assets/javascripts/templates/sponsorship · high confidence

New tags plugin for organizing content by tags

A new tags plugin has been introduced to collect tags from page front matter and build a structured tag index. This plugin allows users to generate site-wide tags indexes, render tag-based listings on pages, and export tag mappings to a JSON file. It supports configuration for sorting, filtering, slugification, and shadow tags, and includes built-in handling for deprecated settings to ensure a smooth transition.

src/plugins/tags · high confidence

Offline plugin now supports offline search and iframe polyfills

The offline plugin has been refactored to enable search functionality when viewing the site without a server. It now inlines the search index into a JavaScript file during the build process and automatically includes the iframe-worker shim in the polyfills list. Additionally, directory URLs are disabled by default to ensure correct link resolution when browsing locally.

material/plugins/offline, src/plugins/offline · high confidence

Removals

Removal of legacy application.js logic

The legacy \src/assets/javascripts/application.js\ file has been removed, eliminating the previous monolithic JavaScript implementation that handled drawer alignment, search indexing via Lunr, and various DOM manipulations. This change signifies a structural shift away from the old single-file application logic, likely as part of a broader refactoring or migration to a new build system or component architecture.

src/assets/javascripts · high confidence

Removal of legacy article appearance and layout stylesheets

The \\_appearance.scss\ and \\_layout.scss\ files within the \src/assets/stylesheets/modules/article\ directory have been deleted. This removes the previous styling rules for article content, including specific color schemes for headlines and links, table border-radius and shadow effects, footer styling, and layout adjustments for iOS standalone modes and tablet breakpoints. Users will no longer see these legacy visual styles applied to article content.

src/assets/stylesheets/modules/article · high confidence

Architecture

JavaScript components restructured into a modular architecture

The JavaScript component system has been reorganized from a monolithic structure into a modular, feature-specific layout under \src/templates/assets/javascripts/components\. This change introduces a new \\_/index.ts\ file that defines a centralized \ComponentType\ map and helper functions (\getComponentElement\, \getComponentElements\) for locating UI elements by their \data-md-component\ attribute. Individual components such as \announce\, \consent\, \content\, and \mermaid\ are now isolated in their own directories with dedicated entry points, improving code maintainability and separation of concerns without altering the external API or user-facing behavior.

src/templates/assets/javascripts/components · high confidence

Refactored main stylesheet into modular SCSS components

The main stylesheet has been restructured into distinct, modular SCSS files (\_colors, \_icons, \_resets, \_typeset) to improve maintainability and organization. This change introduces a new color variable system for primary and accent shades, standardizes icon rendering for SVGs, applies comprehensive browser resets for box models and typography, and defines the core typeset styles for headings, links, and code blocks.

src/templates/assets/stylesheets/main · high confidence

Refactored tags plugin structure into modular components

The tags plugin's internal structure has been reorganized into a modular package under \src/plugins/tags/structure\. This change introduces dedicated modules for managing tag hierarchies (\Tag\), mapping pages to tags (\Mapping\), and handling listing configurations and rendering (\Listing\, \ListingManager\). It also adds support for persisting tag mappings to JSON via \MappingStorage\ and validates tag inputs using \TagSet\. This refactoring isolates the core data structures and logic, improving maintainability and enabling features like hierarchical tags and cross-project tag sharing.

src/plugins/tags/structure · high confidence

Repository restructured with new build tooling and configuration files

The project has been restructured, replacing the legacy Gulp-based asset pipeline with a modern setup using ESLint, Stylelint, and TypeScript. This change introduces new configuration files including .eslintrc, .stylelintrc, tsconfig.json, and .browserslistrc, while removing the old Gulpfile.js. The Dockerfile has been updated to use Python 3.11 on Alpine 3.21 and includes tini for better signal handling. The CHANGELOG indicates this is part of the 9.7.7 release which also fixes a DOM-based XSS vulnerability in search suggestions.

(repo-wide) · high confidence

Tags plugin refactored with new internal structure for listings and mappings

The tags plugin's internal architecture has been restructured to improve how tag listings and page mappings are managed. This change introduces dedicated modules for handling tag hierarchies, listing configurations (including scope, inclusion/exclusion filters, and table of contents integration), and a new mapping system that decouples tag data from MkDocs' internal page objects. It also adds support for serializing and sharing tag mappings across multiple MkDocs projects via JSON storage.

material/plugins/tags/structure · high confidence

Behavioural changes

6 commits (1 fix) modifying material/extensions

A change to existing behaviour in material/extensions — 6 commits (1 fix), 3 files: “Added emoji extension”; “Updated copyright year”; “Improved extension compatibility with Python 3.8”; and 2 more.

material/extensions, src/extensions · medium confidence · unverified

Added version info to entrypoint

The package entry point now exposes a \_\version\\_ variable, enabling users and tools to programmatically determine the installed version of the software.

src · high confidence

Blog plugin structure refactored with improved date handling and metadata parsing

The blog plugin's internal structure has been reorganized into dedicated modules (structure, config, markdown, options) to improve maintainability and fix several bugs. Key changes include robust UTF-8 with BOM encoding support for post files, deterministic sorting of categories, and stricter validation of post dates that ensures timezones are handled correctly (preventing crashes on missing or ambiguous timezone data). The metadata parser now explicitly rejects MultiMarkdown syntax in favor of standard YAML, and excerpt rendering has been optimized with a dedicated tree processor to correctly resolve internal anchors and relative links within blog views.

src/plugins/blog/structure · high confidence

Blog readtime calculation now ignores non-content HTML elements

The blog readtime plugin has been refactored to use a custom HTML parser that excludes text inside \<script\>, \<style\>, \<object\>, and \<svg\> tags from word counts, ensuring that estimated reading times reflect only visible content. This change replaces the previous external dependency with a lightweight, self-contained implementation, reducing Docker image size and improving the accuracy of readtime estimates for users.

material/plugins/blog/readtime, src/plugins/blog/readtime · high confidence

Build system restructured with new RxJS-based pipeline and Windows fixes

The build tooling in tools/build has been restructured, moving scripts into subfolders and replacing deprecated RxJS operators with the new RxJS API. This change introduces a new copy module and refactors the main build index to use RxJS observables for asset processing, including SVG optimization and file copying. Additionally, specific fixes address Windows compatibility by ensuring POSIX-style path separators and correcting the output order of the \build:all\ task, while also fixing issues with FontAwesome icon fill attributes and asset URLs after the restructuring.

tools/build · high confidence

Centralized configuration and feature flag system for instant navigation and UI components

The JavaScript assets now include a centralized configuration module that exposes global settings, feature flags, and translations to the rest of the application. This change introduces support for instant navigation features, including a progress indicator, prefetching, and preview modes, as well as auto-replacement of meta tags during instant loading. Users benefit from a more consistent and extensible foundation for UI behaviors like code copying, search highlighting, and navigation tracking, all driven by the new feature flag system.

src/templates/assets/javascripts/\ · high confidence_

Drawer styles refactored into modular SCSS files

The drawer styling has been reorganized from a single monolithic file into four distinct SCSS modules: \_animation.scss, \_appearance.scss, \_layout.scss, and \_typography.scss. This change improves maintainability by separating concerns, allowing developers to modify animation, visual appearance, layout structure, and typography independently without affecting other aspects of the drawer component.

src/assets/stylesheets/modules/drawer · high confidence

Improved reliability and stability of instant navigation

This update addresses several bugs in the instant navigation integration to provide a smoother browsing experience. It fixes issues where anchor links were ignored or caused crashes, resolves relative image paths correctly, and prevents visual flashes during loading. Additionally, it ensures that meta tags and color theme settings are preserved during navigation, and adds support for a progress indicator to give users feedback while pages load.

src/templates/assets/javascripts/integrations/instant · high confidence

Improved version selector navigation and outdated banner handling

The version selector now intelligently maps user clicks to the corresponding page in the selected version by consulting the site sitemap, ensuring that navigation preserves the current path and URL parameters (hash and query string) even when switching between versions. Additionally, the logic for displaying the outdated version warning banner has been refined to correctly scope the check to the site's base URL and properly respect user-configured default version strings, preventing the banner from incorrectly appearing on versions that should be treated as current.

src/templates/assets/javascripts/integrations/version · high confidence

Material theme version updated to 9.7.7

The material theme package has been updated to version 9.7.7, as reflected in the \_\init\\_.py module. This change ensures that the installed theme reports the correct version number to the application.

material · high confidence

New JavaScript bundle and alternate version navigation support

This change introduces a new centralized JavaScript entry point (bundle.ts) that consolidates core application logic, including media query handling, keyboard shortcuts, and component mounting. It adds support for alternate version navigation, allowing users to seamlessly switch between different versions of the site (e.g., different documentation versions hosted on separate domains) by intercepting clicks and resolving paths via fetched sitemaps. Additionally, it integrates instant navigation progress indicators and fixes tooltip behavior during instant navigation.

src/templates/assets/javascripts · high confidence

New JavaScript partials for user preferences and UI state

This change introduces a set of new JavaScript template partials in src/templates/partials/javascripts that handle client-side user preferences and UI state management. Specifically, it adds scripts to persist and restore color palette preferences (including system dark/light mode detection), manage consent form interactions, handle content tab selection persistence, control the visibility of announcement and outdated-version banners, and provide core utility functions for scoped local/session storage access.

src/templates/partials/javascripts · high confidence

New JavaScript patches for ellipsis tooltips, indeterminate checkboxes, and scroll handling

This change introduces a new modular patch system in the JavaScript assets, adding specific handlers for UI behaviors. The ellipsis patch now mounts improved tooltips on truncated text elements (respecting the \content.tooltips\ feature flag) and on status elements, replacing the previous native title attribute behavior. A new indeterminate patch ensures navigation toggle checkboxes maintain their indeterminate state correctly, particularly on tablet viewports. Additionally, scroll handling is refined: the scrollfix patch now explicitly targets Apple devices to fix overflow scrolling issues, and the scrolllock patch prevents body scrolling when the search overlay is active on mobile devices, restoring the previous scroll position upon closing.

src/templates/assets/javascripts/patches · high confidence

New blog post structure and configuration system

The blog plugin now uses a dedicated structure module to handle post metadata, configuration, and excerpt rendering. This introduces a new \Post\ class that reads YAML metadata with UTF-8 BOM support and integrates with the meta plugin for metadata merging. It adds a \PostConfig\ schema supporting authors, categories, dates (with timezone handling), drafts, pins, and links. Excerpts are now rendered via a custom Markdown tree processor that correctly resolves internal anchors and relative paths within views. Custom config options ensure unique categories/authors and normalize date formats to UTC datetimes.

material/plugins/blog/structure · high confidence

New build transform pipeline with esbuild and PostCSS

The build system in tools/build/transform has been restructured to use esbuild for JavaScript bundling and PostCSS for stylesheet processing. Scripts are now transpiled to the es2015 target with inline legal comments and optional minification, while stylesheets are compiled via SASS and processed through a PostCSS pipeline including autoprefixer, postcss-logical, and other plugins. This change introduces a new transform mechanism for both scripts and styles, replacing the previous build approach.

tools/build/transform · high confidence

New component type definitions and element retrieval utilities

A new index file introduces TypeScript type definitions for icon search and sponsorship components (including query, result, select, count, and total variants) and provides helper functions to retrieve DOM elements by these component types using the data-mdx-component attribute.

src/overrides/assets/javascripts/components/\ · high confidence_

New stylesheets for pymdownx extensions

The project has restructured its styling by introducing dedicated SCSS files for the pymdownx extensions (arithmatex, critic, details, emoji, highlight, keys, tabbed, and tasklist). This change provides specific visual rules for mathematical rendering (MathJax/KaTeX), code highlighting, collapsible details, tabbed content, and task lists, ensuring consistent appearance and fixing layout issues such as horizontal scrollbars in math containers and marker artifacts in Firefox.

src/templates/assets/stylesheets/main/extensions/pymdownx · high confidence

Privacy plugin configuration and core architecture introduced

The privacy plugin now exposes a structured configuration schema (PrivacyConfig) allowing users to control asset fetching, caching, logging, and link handling via options like assets\_fetch, assets\_include/exclude, and links\_noopener. The plugin's core logic has been refactored to use a streaming HTML parser (FragmentParser) instead of lxml to reduce Docker image size, and implements concurrent downloading of external assets via ThreadPoolExecutor with configurable concurrency limits.

material/plugins/privacy · high confidence

The privacy plugin now provides granular control over external resources through new configuration options. Users can enable or disable the fetching of external assets (CSS, JS, images) and links, specify directories for downloaded assets, and define inclusion/exclusion patterns via \assets\_include\, \assets\_exclude\, and \assets\_expr\_map\. Additionally, the plugin now supports adding \rel=noopener\ to external links by default and allows mapping custom attributes via \links\_attr\_map\. Deprecated settings like \external\_assets\ have been moved to the new \assets\ and \links\ namespaces to streamline configuration.

src/plugins/privacy · high confidence

Redesigned admonitions, footnotes, and table of contents styling

The visual presentation of Markdown content has been updated with new styles for admonitions, footnotes, and the table of contents. Admonition blocks now feature a distinct border, background color, and icon-based titles that vary by flavor (e.g., note, warning, success), with improved focus states and nested spacing. Footnote backreferences are now displayed as icons that appear on hover or focus, with specific adjustments for right-to-left (RTL) languages to ensure correct orientation. The table of contents section introduces visible headerlinks that appear on hover or focus, and uses modern CSS scroll-margin properties to improve anchor scrolling behavior, particularly with sticky headers.

src/templates/assets/stylesheets/main/extensions/markdown · high confidence

The template structure for the site has been reorganized into a new set of partials, fundamentally changing how the interface is rendered. The navigation system now uses dedicated \nav-item\, \nav\, \tabs\, and \path\ components, introducing support for navigation pruning and section-based layouts. Content pages are now assembled via a \content\ partial that explicitly includes tags, actions, and feedback, while a new \consent\ partial provides a built-in cookie consent manager with granular control over analytics and social cookies. Additionally, a \progress\ partial adds a reading progress indicator, and the \source-file\ partial now supports displaying local author avatars and configurable email visibility for contributors.

material/templates/partials · high confidence

Refactored browser utilities into a modular, RxJS-based architecture

The browser-side JavaScript utilities have been restructured into a modular, RxJS-based architecture. This change introduces new, dedicated modules for observing document state, element properties (such as size, offset, visibility, and focus), keyboard interactions, and network requests. Notably, the network request module now utilizes XMLHttpRequest to support download progress tracking and request cancellation, addressing limitations of the Fetch API. Additionally, the location handling module has been updated to support instant navigation by intercepting link clicks via a temporary anchor element, and the element focus observer has been improved to use bubbling focus events for better accuracy with nested focusable elements.

src/templates/assets/javascripts/browser · high confidence

Refactored build tooling to use RxJS observables and Chokidar for file watching

The build system in tools/build/\_ has been rewritten to leverage RxJS for handling asynchronous file operations and Chokidar for file watching. This change introduces a new \resolve\ function that returns an Observable of file paths, supporting both standard resolution and live watching modes via the \--watch\ flag. It also adds a \write\ function that caches file contents to avoid redundant disk writes and optionally logs changes when \--verbose\ is enabled. These updates improve the semantics of the build pipeline, particularly regarding file change detection and output consistency.

tools/build/\ · high confidence_

Refactored icon search result logic to support mode-based filtering

The icon search result component has been restructured to handle different search modes (icons, emojis, or all) via a new \mode$\ observable. The \watchIconSearchResult\ function now branches based on the \data-mdx-mode\ attribute: in 'file' mode, it searches only icon shortcodes, while the default mode combines both icons and emojis based on the current search mode setting. This change improves the discoverability and accuracy of search results by respecting the user's selected search context.

src/overrides/assets/javascripts/components/iconsearch/result · high confidence

Refactored template structure and improved accessibility

The template system has been restructured into modular partials, introducing new components for cookie consent management, user feedback collection, and a reading progress indicator. Accessibility has been enhanced by adding a rel=edit attribute to the edit button link, fixing unescaped quotes in ARIA labels, and ensuring the navigation expander is keyboard-focusable. The search interface now correctly respects the enabled setting, and navigation pruning logic has been fixed to handle active tabs and sections properly.

src/templates/partials · high confidence

Removal of custom icon font definitions

The custom icon font styles and font-face declarations have been removed from the theme's stylesheet. This change eliminates the local definition of the 'Icon' font family and its associated CSS classes (such as .icon-search, .icon-github, etc.), meaning the visual rendering of these icons will now depend on external sources or alternative styling mechanisms rather than the previously bundled font files.

src/assets/stylesheets/fonts · high confidence

Removal of legacy Materialize theme templates and breakpoint mixins

The legacy Materialize theme assets have been removed, specifically the SCSS breakpoint mixin library (src/assets/stylesheets/mixins/\_break.scss) and the core Jinja2 view templates (src/views/base.html, drawer.html, footer.html, header.html, toc.html). This eliminates the previous responsive breakpoint logic and the standard documentation layout structure, including the navigation drawer, header, footer, and table of contents rendering, which will require replacement by the new theme implementation.

src/assets/stylesheets/mixins, src/views · high confidence

Removal of legacy base stylesheet modules

The base stylesheet modules for animation, appearance, and layout have been removed from the project. This deletion eliminates the previous CSS rules governing page structure, visual styling, and transition effects, indicating a shift away from the legacy styling approach in this area.

src/assets/stylesheets/modules/base · high confidence

Removal of legacy stylesheet modules

The codebase has removed several core stylesheet files, including the global reset (\_reset.scss), print overrides (\_print.scss), and the complete search module (\_highlight.scss, \_animation.scss, \_appearance.scss, \_layout.scss). This change eliminates the previous CSS-based styling for code syntax highlighting, print layouts, and the search interface animations and layout, indicating a shift away from these specific visual implementations.

src/assets/stylesheets · high confidence

Replaced SCSS stylesheets with Mermaid type declarations

The file previously located at src/assets/stylesheets/application.scss has been renamed to typings/mermaid/index.d.ts and its content has been completely replaced. The original SCSS file, which imported various Bourbon, Quantum, and application-specific modules (such as drawer, article, and search), has been removed. In its place, a TypeScript declaration file has been added that declares a global 'mermaid' variable as type 'any', effectively shifting this location from providing CSS styles to providing type definitions for the Mermaid library.

typings/mermaid · high confidence

Replaced article animation styles with outbound click analytics tracking

The file previously responsible for article styling animations (specifically the fade color effect on highlighted code spans and copyright links) has been replaced by a new JavaScript module that sets up analytics. This new module subscribes to document body click events and sends 'outbound' click events via Google Analytics for any links navigating to a different origin, effectively removing the visual animation behavior in favor of tracking external link clicks.

src/overrides/assets/javascripts/integrations · high confidence

Replaces SCSS styles with DOM type definitions

The file previously located at src/assets/stylesheets/\_shame.scss has been moved to typings/dom/index.d.ts and converted from SCSS to TypeScript. This change removes legacy CSS rules for tablet landscape layouts (such as project name coloring and button-menu hiding) and instead defines a global TypeScript interface for FormData, adding a keys() method that returns an IterableIterator of strings.

typings/dom · high confidence

Restructured JavaScript component and template exports

The project has reorganized its JavaScript module structure by introducing a new \components/index.ts\ file that explicitly exports the \iconsearch\ and \sponsorship\ modules. Additionally, the previous \src/assets/stylesheets/\_palette.scss\ file has been removed and replaced with a new \templates/index.ts\ file, which also exports the \iconsearch\ and \sponsorship\ modules, effectively consolidating these specific feature exports into the new templates entry point.

src/overrides/assets/javascripts/components, src/overrides/assets/javascripts/templates · high confidence

Restructured and restyled custom theme assets

The custom stylesheets have been reorganized into a modular structure, introducing dedicated SCSS files for the landing page hero, announcement banner, icon search, and sponsorship sections. This restructuring brings visual updates to the landing page hero, including a new gradient background and slate theme adjustments, while the icon search now features a refined result list with a type-selection dropdown and improved dark-mode styling. Additionally, sponsorship displays have been updated with new layouts for premium sponsors and interactive hover effects on sponsor avatars.

src/overrides/assets/stylesheets · high confidence

Restructured color palette into modular SCSS files

The color palette styles have been reorganized into three distinct files: \_accent.scss, \_primary.scss, and \_scheme.scss. This change separates the definition of accent colors, primary color themes (including specific handling for white and black schemes), and the slate (dark mode) scheme rules. Users will see no visual change, but the underlying stylesheet structure is now more modular, making it easier to maintain and customize specific color aspects independently.

src/templates/assets/stylesheets/palette · high confidence

Restructured stylesheet architecture and added print/comment hiding

The stylesheet organization has been restructured into a modular system with dedicated entry points for main styles and palette configuration, importing specific component and extension modules. This change introduces a new grid layout system for content cards and an inline floating modifier for sidebars. Additionally, print styles have been updated to hide the comment section (including Giscus) and the Mermaid diagram integration now uses dedicated CSS variables for consistent theming.

src/templates/assets/stylesheets · high confidence

Restructured template layout and added blog post author support

The template directory has been restructured into a new modular layout, introducing dedicated templates for blog posts and the blog index alongside a new 404 page and a redirect template. For blog posts, the sidebar now displays author profiles, including support for local author avatars and clickable author names if a URL is provided. Additionally, the theme initialization script now automatically suppresses the MkDocs 2.0 compatibility warning when running in forked environments.

src/templates · high confidence

Restructured theme template layout and added blog post support

The theme's template structure has been reorganized, introducing a new base layout (base.html) and a dedicated blog-post template that displays author avatars, publication dates, categories, and reading time in a sidebar. A new 404.html template provides a standard not-found page, while a redirect.html template handles URL redirections. Additionally, the \_\init\\_.py file now includes logic to automatically display a warning about MkDocs 2.0 compatibility when running in the MkDocs context.

material/templates · high confidence

Search integration restructured with improved highlighting and query handling

The search integration has been restructured into a modular TypeScript architecture, introducing a custom tokenizer that is aware of HTML tags and supports multi-character splitting for more accurate indexing. Search result highlighting now correctly escapes HTML entities (such as \&amp;\) and properly handles code blocks in titles, while query parsing includes fixes for wildcard detection and improved segmentation for Asian languages via Lunr.js.

src/templates/assets/javascripts/integrations/search · high confidence

Search plugin restructured with improved stability and configuration

The search plugin has been refactored to improve resilience and fix several crashes. It now handles edge cases such as empty titles, numeric tags, empty tag keys, and nested headlines that previously caused errors. The plugin also correctly applies search boosts to document sections and preserves indentation in code blocks. Configuration options like 'indexing', 'prebuild\_index', and 'min\_search\_length' are now deprecated as unsupported. The plugin uses the 'backrefs' library for regex operations and supports Chinese text segmentation via 'jieba'.

src/plugins/search · high confidence

Search plugin rewritten for stability and robustness

The search plugin has been completely rewritten to fix multiple crashes and indexing errors. This update resolves issues where search would fail on empty or numeric tags, crash on specific page titles or nested headlines, and incorrectly handle whitespace and code blocks. It also improves resilience during incremental builds and theme changes, ensuring a more reliable search experience for users.

material/plugins/search · high confidence

Social plugin introduces configurable card layouts and sandboxed template engine

The social plugin now supports customizable social media cards through a new YAML-based layout system (default, accent, invert, variant, and image-only templates) that allows users to define background colors, fonts, and layer positioning. The plugin also switches to a sandboxed Jinja environment for rendering these templates, improving security and stability, while introducing configuration options for caching, concurrency, and debug modes to optimize build performance.

material/plugins/social · high confidence

Social plugin restructured with configurable card layouts and sandboxed rendering

The social plugin has been refactored to support customizable social card designs through a new layout system defined in YAML templates (default, accent, invert, variant, and only/image). Card generation now uses a sandboxed Jinja environment for safer template rendering, and the plugin includes a comprehensive configuration schema (SocialConfig) that deprecates old settings like cards\_color and cards\_font in favor of cards\_layout\_options. This change also introduces parallelized image saving and caching to improve build performance, while ensuring cards correctly display the site name on the homepage and handle font loading more robustly.

src/plugins/social · high confidence

Tags plugin configuration and structure refactored for MkDocs compatibility

The tags plugin's configuration schema has been updated to use MkDocs' class-based config options, introducing explicit settings for tag slugification, hierarchy, sorting, and shadow tags, while deprecating older comparison-based settings. The plugin now includes dedicated configuration classes for tag structures and listings, ensuring better type safety and alignment with current MkDocs standards.

material/plugins/tags · high confidence

Updated and expanded language translation files

The language translation partials in \material/templates/partials/languages\ have been updated with new and revised translations for multiple languages, including Afrikaans, Arabic, Azerbaijani, Belarusian, Bulgarian, Bengali, Catalan, Czech, Welsh, Danish, German, Greek, English, Esperanto, Spanish, Estonian, Basque, Persian, Finnish, French, Galician, Hebrew, Hindi, Croatian, Hungarian, Armenian, and Indonesian. These changes ensure that interface elements, search placeholders, and navigation labels are correctly localized for users selecting these languages.

material/templates/partials/languages, src/templates/partials/languages · high confidence

Updated bundled JavaScript assets

The bundled JavaScript file for the Material theme has been replaced with a new version. This update includes the focus-visible polyfill for improved keyboard navigation accessibility, the escape-html utility for safer content rendering, and clipboard.js v2.0.11 to enable copy-to-clipboard functionality. The bundle also incorporates a comprehensive set of reactive stream operators (RxJS-style) for handling asynchronous events, DOM observations, and data transformations within the theme's client-side logic.

material/overrides/assets, material/templates/assets · high confidence

Fixes

Added empty \_\_init\_\_.py files to plugin directories

New empty \_\init\\_.py files have been added to the material/plugins and src/plugins directories. This change ensures these directories are recognized as Python packages, which resolves import errors where the 'material.plugins' module could not be found.

material/plugins, src/plugins · high confidence

Dependencies

Updated frontend and Python dependencies

The build environment and runtime dependencies have been updated to their latest compatible versions. Frontend tooling now uses esbuild 0.28.1, TypeScript 5.9.3, and Stylelint 16.26.1, while Python dependencies include MkDocs 1.6+, Pygments 2.16+, and Pillow 10.2+ to ensure compatibility and address security vulnerabilities.

(dependencies) · high confidence

Written by cca.canine.dev from the codebase's own history, inside the signed delivery this page is composed from.

How this codebase got here

This is the PUBLIC form of this artifact. Findings are listed in full, but the details of SECURITY findings — which rule fired, in which file, on which line, and how to fix it — are deliberately withheld, and any secret-scanner results are excluded entirely. Where detail is absent here it was REMOVED FOR PUBLICATION; it is not missing from the analysis. The complete artifact is available from the repository owner.

Score

  • CAI 48 → 49 (+1.8)
  • Rubric changed (rubric-2026.11.2 → rubric-2026.11.4) — scores are not directly comparable.

Lenses

  • Code Health 60 → 57 (-3.1)
  • Architecture 91 → 97 (+6.3)
  • Maturity 68 → 72 (+3.3)
  • Readiness 40 → 40 (+0.0)
  • Security 63 → 70 (+6.8)
  • Accessibility 40 → 46 (+5.5)
  • Performance 100 → 100 (+0.0)

Resolved (44)

  • Duplicated block (16 lines × 2) (material/overrides/hooks/shortcodes.py)
  • Duplicated block (23 lines × 2) (material/plugins/projects/structure/init.py)
  • Duplicated block (42 lines × 2) (material/plugins/social/plugin.py)
  • High CVE: [GHSA redacted] (package-lock.json)
  • High secret: WD-SECRET-0005 (package-lock.json)
  • High: security finding (details withheld)
  • High: security finding (details withheld)
  • High: security finding (details withheld)
  • High: security finding (details withheld)
  • High: security finding (details withheld)
  • High: security finding (details withheld)
  • High: security finding (details withheld)
  • High: security finding (details withheld)
  • High: security finding (details withheld)
  • High: security finding (details withheld)
  • High: security finding (details withheld)
  • High: security finding (details withheld)
  • High: security finding (details withheld)
  • High: security finding (details withheld)
  • High: security finding (details withheld)
  • …and 24 more

New (13)

  • Edited copy of a member (2 corresponding lines) (material/overrides/hooks/shortcodes.py)
  • Edited copy of a member (2 corresponding lines) (material/overrides/hooks/shortcodes.py)
  • Edited copy of a member (2 corresponding lines) (material/overrides/hooks/shortcodes.py)
  • Edited copy of a member (3 corresponding lines) (material/overrides/hooks/shortcodes.py)
  • Edited copy of a member (3 corresponding lines) (material/plugins/blog/plugin.py)
  • Edited copy of a member (3 corresponding lines) (material/plugins/info/plugin.py)
  • Edited copy of a member (3 corresponding lines) (material/plugins/social/plugin.py)
  • Edited copy of a member (4 corresponding lines) (material/plugins/optimize/plugin.py)
  • Edited copy of a member (4 corresponding lines) (material/plugins/projects/builder/init.py)
  • Edited copy of a member (4 corresponding lines) (material/plugins/search/plugin.py)
  • Edited copy of a member (4 corresponding lines) (material/templates/init.py)
  • High: security finding (details withheld)
  • No ADRs found (package.json)

Changes since last survey

  • 4 commits — 2 feature/other, 2 fixes

By area

  • (root) — 2 commits
  • .github/workflows — 2 commits

Notable commits

  • fix: Fixed documentation workflow
  • fix: Updated dependencies to fix vulnerabilities
  • change: Harden build and publishing workflows
  • change: Prepare 9.8.1 release

Written by cca.canine.dev from the codebase's own history, inside the signed delivery this page is composed from.

Survey your own repository

squidfunk/mkdocs-material was measured the same way every project in this corpus was: the same rubric, at a pinned commit, with the result published in full. Point a surveyor at a repository you know and see whether you agree with it.

About this page

  • The score is its most recent published measurement, taken on 16 November 2026 at a pinned commit. It is not a live figure and does not change until the project is measured again.
  • Measured at commit ec6319412936a1aa50285192fbc8b816d396c12c — the exact code this score is about.
  • Scored under rubric-2026.11.4 — the same rubric and the same method as every other entry in this index.
  • Measured by Canine Code Analyzer (cca.canine.dev) using cca measure-2026.11.73+preprod-52de90b74216.