From 4d2a51ac8d5fe30b0e185e30a4b948cfad3de2c7 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Wed, 14 Oct 2026 20:44:55 +0200 Subject: [PATCH 1/2] docs: retire Insiders section Signed-off-by: squidfunk --- .../blog/posts/the-past-present-and-future.md | 2 +- docs/insiders/changelog/index.md | 1127 ----------------- docs/insiders/getting-started.md | 176 --- docs/insiders/index.md | 4 - docs/insiders/upgrade.md | 79 -- docs/plugins/projects.md | 2 +- docs/plugins/typeset.md | 2 +- material/overrides/hooks/shortcodes.py | 8 +- mkdocs.yml | 12 +- src/overrides/hooks/shortcodes.py | 8 +- 10 files changed, 17 insertions(+), 1403 deletions(-) delete mode 100644 docs/insiders/changelog/index.md delete mode 100644 docs/insiders/getting-started.md delete mode 100644 docs/insiders/index.md delete mode 100644 docs/insiders/upgrade.md diff --git a/docs/blog/posts/the-past-present-and-future.md b/docs/blog/posts/the-past-present-and-future.md index f3ec9645e84..f5585554070 100644 --- a/docs/blog/posts/the-past-present-and-future.md +++ b/docs/blog/posts/the-past-present-and-future.md @@ -159,7 +159,7 @@ Furthermore, a large amount of time was invested into refactoring the code base to keep it in good shape. While the `mkdocs-material` package was released __55__ times, `mkdocs-material-insiders` was shipped __72__ times. - [Insiders]: ../../insiders/index.md + [Insiders]: insiders-now-free-for-everyone.md [Admonition inline blocks]: ../../reference/admonitions.md#inline-blocks [Advanced search highlighting]: search-better-faster-smaller.md#accurate-highlighting [Anchor tracking]: ../../setup/setting-up-navigation.md#anchor-tracking diff --git a/docs/insiders/changelog/index.md b/docs/insiders/changelog/index.md deleted file mode 100644 index 4d7ba8b870c..00000000000 --- a/docs/insiders/changelog/index.md +++ /dev/null @@ -1,1127 +0,0 @@ -# Changelog - -## Material for MkDocs Insiders - -### 4.53.17 August 22, 2025 { id="4.53.17" } - -- Fixed #8408: Code annotations bug with custom selectors - -### 4.53.16 March 13, 2025 { id="4.53.16" } - -- Fixed #8019: Tooltips have precedence over instant previews - -### 4.53.15 January 15, 2025 { id="4.53.15" } - -- Fixed #7896: Scoped tags listings not rendering in subsections - -### 4.53.14 September 29, 2024 { id="4.53.14" } - -- Fixed #7567: Empty headlines when using typeset plugin with anchorlinks - -### 4.53.13 September 14, 2024 { id="4.53.13" } - -- Fixed #7520: Social plugin errors for generated files (MkDocs 1.6+) - -### 4.53.12 August 2, 2024 { id="4.53.12" } - -- Fixed #7410: Instant previews jump on content tabs with anchor links -- Fixed #7408: Instant previews jump on content tabs - -### 4.53.11 May 27, 2024 { id="4.53.11" } - -- Fixed projects plugin crashing when serving before building subprojects - -### 4.53.10 May 20, 2024 { id="4.53.10" } - -- Fixed projects plugin crashing in serve mode when disabled -- Fixed projects plugin crashing when building nested projects - -### 4.53.9 May 20, 2024 { id="4.53.9" } - -- Fixed #7191: Tags listings not rendering when `toc_depth` is changed - -### 4.53.8 April 26, 2024 { id="4.53.8" } - -- Fixed #7052: Preview extension automatically including all pages -- Fixed #7051: Instant previews mounting on footnote references -- Fixed #5165: Improved tooltips not mounting in sidebar for typeset plugin - -### 4.53.7 April 25, 2024 { id="4.53.7" } - -- Fixed #7060: Incorrect resolution of translation when using static-i18n - -### 4.53.6 April 5, 2024 { id="4.53.6" } - -- Ensure working directory is set for projects when using projects plugin -- Fixed #6970: Incorrect relative paths in git submodules with projects plugin - -### 4.53.5 April 2, 2024 { id="4.53.5" } - -- Fixed social plugin crashing when no colors are specified in palettes - -### 4.53.4 March 31, 2024 { id="4.53.4" } - -- Fixed #6973: Escaping issue in tags extra files deprecation helper - -### 4.53.3 March 23, 2024 { id="4.53.3" } - -- Added support for font variants in social plugin -- Improved resilience of font resolution in social plugin -- Fixed tag listing sometimes not being auto-populated -- Fixed tag listing scope not being correctly resolved -- Fixed #6941: Meta plugin adding duplicate entries -- Fixed #6928: Social plugin crashes for some fonts - -### 4.53.2 March 18, 2024 { id="4.53.2" } - -- Fixed abort on first non-matching configuration in preview extension -- Fixed #6914: Meta files take precedence over front matter - -### 4.53.1 March 6, 2024 { id="4.53.1" } - -- Fixed #6877: Projects plugin computes incorrect path to assets -- Fixed #6869: Blog plugin should emit warning on invalid related link - -### 4.53.0 February 24, 2024 { id="4.53.0" } - -- Added support for automatic instant previews -- Added support for pinned blog posts - -### 4.52.3 February 21, 2024 { id="4.52.3" } - -- Fixed resolution of URLs in instant previews -- Fixed instant previews not mounting for same-page links - -### 4.52.2 February 7, 2024 { id="4.52.2" } - -- Fixed #6735: Instant previews misplaced when below tabs - -### 4.52.1 January 30, 2024 { id="4.52.1" } - -- Fixed #6705: Navigation path not being hidden when specified -- Fixed #6703: New tags plugin crashes on Windows (2nd attempt) - -### 4.52.0 January 28, 2024 { id="4.52.0" } - -- Added support for instant previews -- Fixed footnote tooltips positioning edge cases -- Fixed #6703: New tags plugin crashes on Windows - -### 4.51.0 January 24, 2024 { id="4.51.0" } - -- Added support for footnote tooltips - -### 4.50.0 January 19, 2024 { id="4.50.0" } - -- Added configurable logging capabilities to privacy plugin - -### 4.49.2 January 9, 2024 { id="4.49.2" } - -- Fixed missing attribute lists extension for tags plugin -- Fixed #6627: New tags plugin crashes on Python 3.8 - -### 4.49.1 January 7, 2024 { id="4.49.1" } - -- Improved interop of new tags plugin with other plugins -- Fixed #6594: Tags plugin doesn't work with mkdocs-macros plugin -- Fixed #6569: Social plugin crashes if in different file system location - -### 4.49.0 December 29, 2023 { id="4.49.0" } - -- Added support for exporting tags and mappings -- Added support for disabling tags and/or listings or both -- Fixed tag links from pages to listings on homepage - -### 4.48.0 December 23, 2023 { id="4.48.0" } - -- Rewrite of tags plugin, now much more powerful -- Added support for nested tags (tag hierarchies, e.g. foo/bar) -- Added support for shadow tags (by list, prefix or suffix) -- Added support for custom tag layouts and templates -- Added support for hiding tags in table of contents -- Added support for configurable inline tag listings -- Added support for automatically linking to closest tag listing -- Added support for scoped listings (limit to subsection of site) -- Added support for multiple instances of tags plugin -- Added support for changing front matter property and template variable -- Added support for tag slugification format strings -- Fixed #6510: Projects plugin out of memory on Linux (4.47.1 regression) -- Fixed projects plugin not notifying plugins about serve mode -- Fixed projects plugin skipping projects on prefix match -- Deprecated tags_file and tags_extra_files settings -- Modernized tags plugin code base - -### 4.47.1 December 11, 2023 { id="4.47.1" } - -- Improved editing experience for projects plugin -- Improved resilience of optimize and social plugin -- Fixed race condition when writing manifest in optimize and social plugin -- Fixed #6475: Logo not taking precedence over icon in social card -- Fixed #6399: Projects plugin doesn't pick up added/removed projects -- Fixed #6306: Projects plugin cache not correctly updated - -### 4.47.0 December 8, 2023 { id="4.47.0" } - -- Added support for staying on page when switching languages -- Added configurable logging capabilities to projects plugin -- Removed temporary warning on blog plugin authors file format change -- Fixed projects plugin logging messages twice on Linux systems -- Fixed projects plugin trying to hoist theme assets of divergent themes -- Fixed compatibility of optimize plugin and projects plugin -- Fixed compatibility of social plugin and projects plugin -- Fixed #6448: Code line selection broken for code blocks with custom ids -- Fixed #6437: Projects plugin crashing for certain site URL configurations -- Fixed #6414: Projects plugin doesn't prefix messages coming from projects - -### 4.46.0 November 26, 2023 { id="4.46.0" } - -- Added support for author profiles in blog plugin -- Fixed custom index pages yielding two navigation items (4.45.0 regression) - -### 4.45.0 November 24, 2023 { id="4.45.0" } - -- Added support for sorting blog categories by post count or custom function -- Improved tags plugin to generate Unicode-aware slugs by default -- Fixed non-deterministic order of multiple authors in blog plugin - -### 4.44.0 November 23, 2023 { id="4.44.0" } - -- Added pagination settings for archive pages in blog plugin -- Added pagination settings for category pages in blog plugin - -### 4.43.1 November 19, 2023 { id="4.43.1" } - -- Added third-party theme support in projects plugin, improving editing -- Fixed #6360: Projects plugin crashes when theme is not Material for MkDocs -- Fixed #6306: Projects plugin not reloading nested project configuration - -### 4.43.0 November 5, 2023 { id="4.43.0" } - -- Added support for GitLab committers (document contributors) -- Fixed #6264: Fixed compatibility with Python < 3.10 -- Fixed #6254: Meta plugin not applying meta files to blog posts - -### 4.42.3 October 27, 2023 { id="4.42.3" } - -- Fixed #6251: Cards in grids cut off on very small screens -- Fixed #6241: Using social plugin + static-i18n plugin errors - -### 4.42.2 October 14, 2023 { id="4.42.2" } - -- Fixed #6186: Privacy plugin ignores hash fragments on images -- Fixed #6180: Projects plugin crashing when adding or removing files - -### 4.42.1 October 5, 2023 { id="4.42.1" } - -- Fixed spacing of related links in blog posts on small screens - -### 4.42.0 September 19, 2023 { id="4.42.0" } - -- Added support for using git submodules in projects plugin -- Added support for transforming project configurations -- Improved resilience of optimize and blog plugin -- Fixed optimize plugin crashing on `.jpeg` extension -- Fixed project URLs not using site URLs in projects plugin - -### 4.41.0 September 11, 2023 { id="4.41.0" } - -- Improved multi-instance support for optimize plugin -- Added inclusion and exclusion patterns for optimize plugin -- Added transparent keyword for color handling in social plugin -- Changed default quality of PNGs to 3 in optimize plugin -- Fixed #5979: meta file not detected in root of docs directory - -### 4.40.4 September 4, 2023 { id="4.40.4" } - -- Fixed privacy plugin choking on boolean HTML5 attributes -- Fixed wrapping of inline code blocks in typeset table of contents -- Fixed blog plugin error when running under dirty reload - -### 4.40.3 September 2, 2023 { id="4.40.3" } - -- Fixed #5946: Docker image missing pngquant for optimize plugin - -### 4.40.2 August 31, 2023 { id="4.40.2" } - -- Added configurable error handling capabilities for social plugin -- Fixed #5922: Blog plugin shows no posts when building a standalone blog -- Fixed #5914: Tags plugin tags_extra_files errors (4.39.3 regression) -- Fixed #5904: Blog plugin sometimes excludes files (4.40.1 regression) - -### 4.40.1 August 27, 2023 { id="4.40.1" } - -- Fixed #5902: ResizeObserver polyfill not detected by privacy plugin -- Fixed empty category pages in blog plugin (4.40.0 regression) - -### 4.40.0 August 26, 2023 { id="4.40.0" } - -- Added logo, title and description options to social plugin default layouts -- Fixed privacy plugin compatibility issue with Python < 3.10 -- Fixed #5896: Blog plugin errors when using custom index pages - -### 4.39.3 August 24, 2023 { id="4.39.3" } - -- Fixed lxml dependency missing in Docker container (4.39.2 regression) - -### 4.39.2 August 23, 2023 { id="4.39.2" } - -- Fixed color palette toggle being reversed (9.2.0 regression) - -### 4.39.1 August 21, 2023 { id="4.39.1" } - -- Fixed git diff in tags plugin after merging back 9.2.0 changes - -### 4.39.0 August 3, 2023 { id="4.39.0" } - -- Added support for hoisting theme media files when building projects -- Added support for sorting pages on tags index for tags plugin -- Added support for adding date of last update to blog posts -- Fixed #5797: Parse error in typeset plugin (4.38.1 regression) - -### 4.38.1 August 1, 2023 { id="4.38.1" } - -- Improved nested serve mode for projects plugin -- Improved compat in privacy plugin with third-party plugins -- Fixed #5790: Typeset plugin ignores data-toc-label attribute -- Fixed #5778: Interplay of privacy plugin with git-revision-date-localized -- Fixed #5773: Info plugin erroring when community edition is in beta - -### 4.38.0 July 29, 2023 { id="4.38.0" } - -- Added projects plugin for building nested projects -- Updated privacy plugin to new MkDocs API - -### 4.37.1 July 28, 2023 { id="4.37.1" } - -- Updated MkDocs to 1.5.1 -- Fixed deprecation warning in social plugin due to MkDocs upgrade -- Fixed #5772: Privacy plugin fails due to API change in MkDocs - -### 4.37.0 July 7, 2023 { id="4.37.0" } - -- Added support for overriding social cards settings per page -- Added new social card `default/only/image` layout -- Improved resilience of optimize and social plugin -- Fixed rendering bugs for pruned navigation items -- Fixed jumping of content tabs anchor links when instant loading is enabled -- Fixed #5676: Optimize plugin doesn't check for `pngquant` - -### 4.36.1 June 23, 2023 { id="4.36.1" } - -- Fixed #5618: Date comparison breaking for drafts in blog plugin - -### 4.36.0 June 15, 2023 { id="4.36.0" } - -- Added support for instant prefetching to speed up slow connections -- Improved stability of anchor link removal in built-in typeset plugin -- Improved performance of regular expressions in typeset plugin -- Removed unnecessary import test for `cairosvg` in optimize plugin -- Fixed #5590: Regular expression for anchor link removal too greedy - -### 4.35.3 June 1, 2023 { id="4.35.3" } - -- Fixed #5579: Abbreviations in headlines filtered by typeset plugin - -### 4.35.2 May 29, 2023 { id="4.35.2" } - -- Fixed #5555: Blog plugin crashes when computing readtime for emojis - -### 4.35.1 May 20, 2023 { id="4.35.1" } - -- Fixed internal handling of errors in social plugin - -### 4.35.0 May 20, 2023 { id="4.35.0" } - -- Improve editing experience and stability of social plugin -- Added support for custom layout syntax validation in social plugin -- Added support for layer origin for easier placement in social plugin -- Added support for in- and exclusion patterns in social plugin -- Catch and print syntax errors in custom layouts - -### 4.34.1 May 16, 2023 { id="4.34.1" } - -- Disable social plugin debug mode by default on mkdocs build -- Added warning in social plugin debug mode when font style couldn't be found -- Set default concurrency of built-in multi-threaded plugins to CPUs - 1 -- Fixed #5521: Social plugin triggers race condition when downloading fonts -- Fixed #5515: Social plugin crashes when concurrency is set to 1 - -### 4.34.0 May 14, 2023 { id="4.34.0" } - -- Added support for new overflow mode to auto-fit text in social plugin -- Reduced subtle rendering bugs in (code) annotations due to subpixel rounding -- Improved print styles for (code) annotation lists -- Improved performance of social plugin, now 3x as fast -- Improved interop of typeset plugin with MkDocstrings -- Fixed logo location for variants of default template in social plugin -- Fixed #5446: Built-in typeset plugin picks up headings in code blocks - -### 4.33.2 May 12, 2023 { id="4.33.2" } - -- Fixed #5508: Social plugin crashes trying to copy cards on Docker/Windows -- Fixed #5507: Social plugin crashes on serve when layouts folder doesn't exist -- Fixed #5505: Social plugin trying to resolve logo in wrong location -- Fixed #5496: Annotations with nested lists incorrectly mounted -- Fixed #5493: Social plugin crashes on Python 3.8 - -### 4.33.1 May 9, 2023 { id="4.33.1" } - -- Added support for SVG background images in social plugin - -### 4.33.0 May 8, 2023 { id="4.33.0" } - -- Added support for custom layouts for social plugin -- Added support for background images for social cards - -### 4.32.6 April 22, 2023 { id="4.32.6" } - -- Fixed #5336: Interplay of blog plugin with git-revision-date-localized - -### 4.32.5 April 7, 2023 { id="4.32.5" } - -- Fixed #5322: Navigation tabs hoist nested page icons - -### 4.32.4 March 24, 2023 { id="4.32.4" } - -- Fixed #5241: Built-in typeset plugin jams navigation for anchors in headings - -### 4.32.3 March 9, 2023 { id="4.32.3" } - -- Fixed Docker image release workflow (9.1.0 regression) -- Fixed #5159: Missing underline for abbreviations (9.1.0 regression) - -### 4.32.2 February 23, 2023 { id="4.32.2" } - -- Fixed #5127: Privacy plugin not handling large number of occurrences -- Fixed #5126: Privacy plugin breaks when replacing specific emojis - -### 4.32.1 February 23, 2023 { id="4.32.1" } - -- Fixed code block spans interfering with copying -- Fixed #5077: Privacy plugin breaks image `alt` text encoding -- Fixed #5079: Privacy plugin removing `rel=me` on external links - -### 4.32.0 February 19, 2023 { id="4.32.0" } - -- Added support for custom selectors for code annotations -- Added support for code line range selection for better sharing - -### 4.31.0 February 18, 2023 { id="4.31.0" } - -- Added support for table of contents on blog index and archive pages -- Fixed #4512: Allow custom search field boosts (experimental) - -### 4.30.2 February 13, 2023 { id="4.30.2" } - -- Fixed privacy plugin excludes not working (4.30.0 regression) - -### 4.30.1 February 12, 2023 { id="4.30.1" } - -- Fixed privacy plugin not handling static templates (e.g. `404.html`) - -### 4.30.0 February 6, 2023 { id="4.30.0" } - -- Rewrite of privacy plugin for concurrency, now twice as fast -- Added support for explicit inclusion for privacy plugin -- Added optimization support for privacy plugin (+ optimize plugin) - -### 4.29.0 January 21, 2023 { id="4.29.0" } - -- Added built-in optimize plugin for automatically compressing images -- Switched reporting in built-in privacy plugin to `info` level - -### 4.28.1 January 17, 2023 { id="4.28.1" } - -- Fixed built-in info plugin erroring for Insiders on version check -- Fixed #4865: Navigation paths render bug when there's no top-level section -- Fixed #4875: Added support for hiding navigation paths -- Improved navigation path to not render for a single item - -### 4.28.0 January 14, 2023 { id="4.28.0" } - -- Added support for navigation path (breadcrumbs) - -### 4.27.1 December 20, 2022 { id="4.27.1" } - -- Fixed rendering of succeeding navigation items in typeset plugin -- Fixed #4795: Built-in typeset plugin changes MkDocs' title precedence -- Fixed #4724: Blog plugin not rendering integrate table of contents - -### 4.27.0 December 20, 2022 { id="4.27.0" } - -- Added built-in typeset plugin to preserve formatting in sidebars -- Added URL and table of contents support for blog categories - -### 4.26.6 November 28, 2022 { id="4.26.6" } - -- Fixed #4683: Tags plugin crashes when a tag is empty - -### 4.26.5 November 27, 2022 { id="4.26.5" } - -- Fixed #4632: Post excerpt title link doesn't point to top of the page - -### 4.26.4 November 27, 2022 { id="4.26.4" } - -- Fixed redundant file extension when using privacy plugin - -### 4.26.3 November 15, 2022 { id="4.26.3" } - -- Fixed #4637: Attachments w/o titles in related links error in blog plugin -- Fixed #4631: Remote favicons not downloaded and inlined by privacy plugin - -### 4.26.2 November 3, 2022 { id="4.26.2" } - -- Updated MkDocs to 1.4.2 -- Added support for tag compare functions when sorting on index pages -- Fixed footnotes being rendered in post excerpts without separators -- Fixed error in blog plugin when `toc` extension is not enabled -- Fixed issues with invalid asset paths and linked post titles -- Fixed #4572: Privacy plugin fails when symlinks cannot be created -- Fixed #4545: Blog plugin doesn't automatically link headline to post -- Fixed #4542: Blog plugin doesn't allow for multiple instances -- Fixed #4532: Blog plugin doesn't allow for mixed use of date and datetime - -### 4.26.1 October 22, 2022 { id="4.26.1" } - -- Improved reporting of configuration errors in tags plugin -- Fixed #4515: Privacy plugin fails when site URL is not defined -- Fixed #4514: Privacy plugin doesn't fetch Google fonts (4.26.0 regression) - -### 4.26.0 October 18, 2022 { id="4.26.0" } - -- Refactored privacy plugin to prepare for new features -- Added support for `rel=noopener` links in privacy plugin -- Resolve encoding issues with blog and privacy plugin - -### 4.25.5 October 16, 2022 { id="4.25.5" } - -- Updated MkDocs to 1.4.1 -- Added namespace prefix to built-in plugins -- Updated `content` and `header` partial - -### 4.25.4 October 9, 2022 { id="4.25.4" } - -- Fixed other path issues for standalone blogs (4.24.2 regression) - -### 4.25.3 October 9, 2022 { id="4.25.3" } - -- Fixed #4457: Posts not collected for standalone blog (4.24.2 regression) - -### 4.25.2 October 4, 2022 { id="4.25.2" } - -- Fixed #4452: Blog and tags plugin crash when specifying slugify function - -### 4.25.1 October 3, 2022 { id="4.25.1" } - -- Updated `mkdocs-rss-plugin` in `Dockerfile` to fix MkDocs compat errors - -### 4.25.0 October 2, 2022 { id="4.25.0" } - -- Added support for navigation subtitles -- Added support for defining an allow list for built-in tags plugin -- Added support for custom slugify functions for built-in tags plugin -- Improved stability of search plugin when using `--dirtyreload` - -### 4.24.2 October 1, 2022 { id="4.24.2" } - -- Updated MkDocs to 1.4 -- Fixed compatibility issues with MkDocs 1.4 -- Fixed incorrectly generated paths in privacy plugin -- Fixed blog index page not showing navigation when using meta plugin - -### 4.24.1 September 30, 2022 { id="4.24.1" } - -- Fixed #4430: build error when enabling consent without repository URL - -### 4.24.0 September 27, 2022 { id="4.24.0" } - -- Added support for custom content on index pages (blog) -- Added support for keeping content on paginated index pages (blog) -- Added support for limiting categories in post excerpts (blog) -- Added support for simple override of templates via front matter (blog) -- Added icon in navigation for pages with encrypted content -- Fixed #4396: Front matter of index pages not inherited by pagination (blog) -- Improved performance by building post excerpts once (blog) - -### 4.23.6 September 22, 2022 { id="4.23.6" } - -- Fixed #4389: Blog posts in first week of year in wrong archive -- Fixed (= switched) footer previous and next links for blog posts - -### 4.23.5 September 18, 2022 { id="4.23.5" } - -- Fixed #4367: Improved blog plugin date handling for MultiMarkdown syntax -- Fixed #4374: Fixed invalid URLs of related links to other blog posts - -### 4.23.4 September 14, 2022 { id="4.23.4" } - -- Fixed #4365: Recursion error in blog plugin due to `deepcopy` -- Fixed path errors for blog plugin on Windows -- Fixed publishing workflow in forked repositories - -### 4.23.3 September 13, 2022 { id="4.23.3" } - -- Fixed previous and next page links for drafts of blog posts - -### 4.23.2 September 13, 2022 { id="4.23.2" } - -- Fixed #4348: Blog plugin crashes on custom `nav` title -- Fixed blog plugin crashing when category contained only drafts -- Fixed rendering of content from blog index file - -### 4.23.1 September 12, 2022 { id="4.23.1" } - -- Fixed #4345: Blog plugin errors with default settings - -### 4.23.0 September 12, 2022 { id="4.23.0" } - -- Added blogging support via built-in blog plugin - -### 4.22.1 September 7, 2022 { id="4.22.1" } - -- Fixed #4217: Tooltips in data tables render in wrong position - -### 4.22.0 August 21, 2022 { id="4.22.0" } - -- Added support for navigation status - -### 4.21.1 August 13, 2022 { id="4.21.1" } - -- Fixed #4176: Broken image when avatar is served by Gravatar -- Fixed #4212: Deferred search initialization for file:// locations - -### 4.21.0 July 17, 2022 { id="4.21.0" } - -- Added meta plugin: set front matter for all pages in a folder -- Fixed #4114: Tags plugin fails if only `tags_extra_files` is set - -### 4.20.1 July 11, 2022 { id="4.20.1" } - -- Fixed #4105: Tags plugin fails if `tags_file` is not set (4.20.0 regression) - -### 4.20.0 July 7, 2022 { id="4.20.0" } - -- Added support for additional tags indexes -- Fixed #4100: Tag icons not shown in tags index - -### 4.19.2 July 4, 2022 { id="4.19.2" } - -- Fixed #4051: Privacy plugin fails if symlinking isn't allowed on Windows - -### 4.19.1 June 25, 2022 { id="4.19.1" } - -- Added `mkdocs-git-committers-plugin` to Dockerfile -- Added `mkdocs-git-revision-date-localized-plugin` to Dockerfile - -### 4.19.0 June 24, 2022 { id="4.19.0" } - -- Added support for document contributors -- Updated French translations for cookie consent - -### 4.18.2 June 16, 2022 { id="4.18.2" } - -- Fixed #4026: Fixed tooltips not mounted for nested navigation links - -### 4.18.1 June 14, 2022 { id="4.18.1" } - -- Fixed #3990: Chinese search highlighting not working on non-boundaries - -### 4.18.0 June 11, 2022 { id="4.18.0" } - -- Added support for automatic dark/light mode -- Fixed #4009: Privacy plugin uses invalid paths for file cache on Windows - -### 4.17.2 June 5, 2022 { id="4.17.2" } - -- Added support for custom jieba dictionaries (Chinese search) - -### 4.17.1 June 5, 2022 { id="4.17.1" } - -- Added support for cookie consent reject button -- Added support for cookie consent custom button ordering -- Fixed #3988: Content tab not focused after alternating anchor links - -### 4.17.0 June 4, 2022 { id="4.17.0" } - -- Added support for content tabs anchor links (deep linking) -- Fixed #3975: Detect composition events in search interface (Chinese) -- Fixed #3980: Search plugin doesn't use title set via front matter - -### 4.16.2 May 29, 2022 { id="4.16.2" } - -- Fixed #3961: Nested sections triggered build error for navigation tabs - -### 4.16.1 May 28, 2022 { id="4.16.1" } - -- Switched feedback widget rating titles to tooltips -- Improved contrast of link colors for light/dark color schemes -- Fixed #3950: Sticky navigation tabs rendering broken (4.15.2 regression) -- Fixed #3958: Links invisible when using `white` primary color - -### 4.16.0 May 25, 2022 { id="4.16.0" } - -- Added support for navigation pruning -- Fixed search results for non-segmented characters (4.15.2 regression) - -### 4.15.2 May 22, 2022 { id="4.15.2" } - -- Removed workaround for `abbr` on touch devices (superseded by tooltips) -- Fixed #3915: Improved Chinese search query segmentation -- Fixed #3938: Fixed tooltips position for navigation titles with ellipsis - -### 4.15.1 May 14, 2022 { id="4.15.1" } - -- Improved performance of element focus observables -- Fixed #3531: Added prev/next buttons to content tabs -- Fixed tooltip positioning when host element is hidden - -### 4.15.0 May 8, 2022 { id="4.15.0" } - -- Added support for improved tooltips -- Fixed #3785: Show tooltip on hover for overflowing navigation link - -### 4.14.0 May 5, 2022 { id="4.14.0" } - -- Added Chinese language support to built-in search plugin -- Fixed all-numeric page titles raising error in social plugin - -### 4.13.2 April 30, 2022 { id="4.13.2" } - -- Improved caching of downloaded resources in privacy plugin -- Fixed #3851: External images not downloaded by privacy plugin - -### 4.13.1 April 25, 2022 { id="4.13.1" } - -- Fixed #3839: Tags plugin breaks without icons (4.13.0 regression) - -### 4.13.0 April 24, 2022 { id="4.13.0" } - -- Added support for tag icons - -### 4.12.0 March 27, 2022 { id="4.12.0" } - -- Added support for card grids and grid layouts -- Fixed #3685: Annotations sometimes broken when using instant loading -- Fixed #3742: Automatically add Mermaid.js when building for offline usage - -### 4.11.0 March 6, 2022 { id="4.11.0" } - -- Added support for excluding external assets from privacy plugin - -### 4.10.1 March 2, 2022 { id="4.10.1" } - -- Added missing build dependencies to Dockerfile -- Fixed encoding issues in privacy plugin, now forcing UTF-8 encoding -- Fixed #3624: Scroll to active navigation item unreliable in Firefox -- Fixed #3642: Privacy plugin errors when font setting was omitted - -### 4.10.0 February 27, 2022 { id="4.10.0" } - -- Added support for offline plugin (supersedes offline search support) -- Improved built-in privacy plugin to download nested JavaScript assets -- Refactored configuration of built-in privacy plugin - -### 4.9.1 February 21, 2022 { id="4.9.1" } - -- Fixed #3610: missing `lxml` dependency for privacy plugin -- Fixed error when charset is missing in `content-type` header - -### 4.9.0 February 20, 2022 { id="4.9.0" } - -- Added privacy plugin: automatic downloading of external assets - -### 4.8.3 February 13, 2022 { id="4.8.3" } - -- Fixed #3560: Mermaid diagrams don't render for `file://` locations - -### 4.8.2 February 10, 2022 { id="4.8.2" } - -- Fixed #3559: Mermaid diagrams don't render inside closed `details` - -### 4.8.1 February 6, 2022 { id="4.8.1" } - -- Fixed jump back to top on mobile when using anchor following - -### 4.8.0 February 6, 2022 { id="4.8.0" } - -- Added support for anchor following table of contents (= auto scroll) - -### 4.7.2 February 2, 2022 { id="4.7.2" } - -- Fixed #3526: Transparent sidebar title due to Safari bug -- Fixed #3528: Firefox sometimes clips text in flow chart diagrams - -### 4.7.1 January 30, 2022 { id="4.7.1" } - -- Fixed #3506: Tags index not respecting title set via front matter - -### 4.7.0 January 25, 2022 { id="4.7.0" } - -- Added native support for offline search - -### 4.6.1 January 16, 2022 { id="4.6.1" } - -- Fixed #3459: Section index pages picking up wrong title - -### 4.6.0 January 11, 2022 { id="4.6.0" } - -- Added support for annotations (outside of code blocks) - -### 4.5.2 January 8, 2022 { id="4.5.2" } - -- Fixed #3440: Content tab indicator not moving when using linking -- Fixed #3445: Content tab switch flickers/jitters when using linking - -### 4.5.1 January 2, 2022 { id="4.5.1" } - -- Added support for setting initial state of cookie consent -- Fixed #3396: Disappearing link in navigation due to Safari bug - -### 4.5.0 December 16, 2021 { id="4.5.0" } - -- Added support for navigation icons - -### 4.4.0 December 10, 2021 { id="4.4.0" } - -- Added support for code annotation anchor links (deep linking) -- Added new code annotation syntax modifier to strip comment -- Updated German translations for cookie consent - -### 4.3.0 December 5, 2021 { id="4.3.0" } - -- Added support for custom fonts in social cards -- Fixed #3300: Announcement bar reappearing when using instant loading - -### 4.2.0 December 2, 2021 { id="4.2.0" } - -- Added support for dismissible announcement bar -- Added support for named placeholders in feedback widget - -### 4.1.0 November 30, 2021 { id="4.1.0" } - -- Added support for passing page title to feedback forms - -### 4.0.0 November 28, 2021 { id="4.0.0" } - -- Removed deprecated content tabs legacy implementation -- Removed deprecated `seealso` admonition type -- Removed deprecated `site_keywords` setting (unsupported by MkDocs) -- Removed deprecated prebuilt search index support -- Removed deprecated web app manifest – use customization -- Removed `extracopyright` variable – use new `copyright` partial -- Removed Disqus integration – use customization -- Switched to `:is()` selectors for simple selector lists -- Switched autoprefixer from `last 4 years` to `last 2 years` -- Improved CSS overall to match modern standards -- Improved CSS variable semantics for fonts -- Improved extensibility by restructuring partials -- Improved handling of `details` when printing -- Improved keyboard navigation for footnotes -- Fixed #3214: Search highlighting breaks site when empty - -### 3.2.3 November 20, 2021 { id="3.2.3" } - -- Updated Swedish and French translations -- Removed support for `.mermaid-experimental` class (now `.mermaid`) -- Fixed #3202: Cookie consent not dismissable on `file://` locations -- Fixed #3216: Cookie consent not dismissed when invoked via anchor -- Fixed #3232: Mermaid.js sometimes runs twice (race condition) - -### 3.2.2 November 6, 2021 { id="3.2.2" } - -- Fixed always last feedback rating being sent -- Fixed #3145: Code annotations eat whole comment lines -- Fixed #3170: Feedback widget doesn't send data to GA4 - -### 3.2.1 November 4, 2021 { id="3.2.1" } - -- Added support for custom Mermaid.js version via additional JavaScript -- Fixed some configuration edge cases for tags plugin (3.1.5 regression) -- Fixed feedback widget title not being centered in Firefox -- Fixed #3179: Safari doesn't send request for feedback widget - -### 3.2.0 October 31, 2021 { id="3.2.0" } - -- Added support for feedback widget (Was this page helpful?) - -### 3.1.5 October 28, 2021 { id="3.1.5" } - -- Fixed #3144: Rogue link when using tags with auto-populated navigation -- Fixed #3147: Code block line numbers appear in search results -- Fixed #3158: Social cards do not strip HTML tags from title - -### 3.1.4 October 17, 2021 { id="3.1.4" } - -- Fixed #2974: Text cropped with other fonts than `Roboto` in social plugin -- Fixed #3099: Encoding problems with non-latin character in social plugin -- Fixed #3112: Japanese segmenter not executed as part of new tokenizer -- Fixed tags (front matter) appearing in search with disabled tags plugin - -### 3.1.3 October 12, 2021 { id="3.1.3" } - -- Added warnings to search plugin for unsupported options and syntax -- Fixed #3503: Search sometimes returns entire page -- Fixed #3089: Single-line code annotations disappear when printing - -### 3.1.2 October 6, 2021 { id="3.1.2" } - -- Fixed incorrect path separators for social cards on Windows - -### 3.1.1 September 26, 2021 { id="3.1.1" } - -- Fixed ordering bug in search exclusion logic - -### 3.1.0 September 26, 2021 { id="3.1.0" } - -- Added support for excluding pages, sections, and elements from search -- Fixed #2803: Code block annotations not visible when printing - -### 3.0.1 September 19, 2021 { id="3.0.1" } - -- Added support for using literal `h1-6` tags for search plugin -- Fixed search plugin breaking on void elements without slashes -- Fixed search plugin filtering link contents from headlines -- Fixed search plugin handling of multiple `h1` headlines -- Fixed search plugin handling of missing `h1` headlines - -### 3.0.0 September 13, 2021 { id="3.0.0" } - -- Rewrite of MkDocs' search plugin -- Added support for rich search previews -- Added support for tokenizer with lookahead -- Improved search indexing performance (twice as fast) -- Improved search highlighting - -### 2.13.3 September 1, 2021 { id="2.13.3" } - -- Added support for disabling social card generation - -### 2.13.2 August 25, 2021 { id="2.13.2" } - -- Fixed #2965: Social plugin error when primary color is not defined - -### 2.13.1 August 21, 2021 { id="2.13.1" } - -- Fixed #2948: Social cards are not cached -- Fixed #2953: Mermaid.js diagrams can't be centered anymore - -### 2.13.0 August 7, 2021 { id="2.13.0" } - -- Added support for custom colors in social cards - -### 2.12.2 August 4, 2021 { id="2.12.2" } - -- Fixed #2891: Division by zero error in social plugin - -### 2.12.1 July 26, 2021 { id="2.12.1" } - -- Fixed error in social plugin when `site_description` was not set -- Fixed error in social plugin for non-ASCII characters - -### 2.12.0 July 25, 2021 { id="2.12.0" } - -- Added support for social cards - -### 2.11.1 July 20, 2021 { id="2.11.1" } - -- Fixed order of tags index, now sorted alphabetically - -### 2.11.0 July 18, 2021 { id="2.11.0" } - -- Improved Mermaid.js integration, now stable -- Added support for sequence diagrams -- Added support for entity relationship diagrams -- Added support for cookie consent configuration -- Added feature flag to always enable annotations - -### 2.10.0 July 10, 2021 { id="2.10.0" } - -- Added support for cookie consent -- Fixed #2807: Back-to-top button not hidden when using sticky tabs - -### 2.9.2 May 30, 2021 { id="2.9.2" } - -- Moved tags to partial for easier customization -- Added support for hiding tags on any page - -### 2.9.1 May 24, 2021 { id="2.9.1" } - -- Added missing guard for linking of content tabs - -### 2.9.0 May 23, 2021 { id="2.9.0" } - -- Added support for linking of content tabs - -### 2.8.0 May 12, 2021 { id="2.8.0" } - -- Added support for boosting pages in search - -### 2.7.2 May 8, 2021 { id="2.7.2" } - -- Fixed #2638: Warnings shown when using `tags` plugin without directory URLs - -### 2.7.1 May 3, 2021 { id="2.7.1" } - -- Fixed `git-revision-date-localized` plugin integration (2.7.0 regression) - -### 2.7.0 May 1, 2021 { id="2.7.0" } - -- Added support for tags (with search integration) - -### 2.6.0 April 11, 2021 { id="2.6.0" } - -- Stay on page when switching versions - -### 2.5.0 March 28, 2021 { id="2.5.0" } - -- Added support for version warning - -### 2.4.0 March 20, 2021 { id="2.4.0" } - -- Added support for custom admonition icons -- Fixed #2444: Code block annotations with extra comments have wrong index - -### 2.3.1 March 14, 2021 { id="2.3.1" } - -- Fixed anchor offset for permalinks when using sticky navigation tabs - -### 2.3.0 March 13, 2021 { id="2.3.0" } - -- Added support for back-to-top button - -### 2.2.1 March 4, 2021 { id="2.2.1" } - -- Fixed #2382: Repository stats failing when no release tag is present - -### 2.2.0 February 28, 2021 { id="2.2.0" } - -- Added support for code block annotations - -### 2.1.0 February 26, 2021 { id="2.1.0" } - -- Added support for anchor tracking - -### 2.0.0 February 24, 2021 { id="2.0.0" } - -- Migrated Insiders to the new architecture -- Swapped color palette toggle configuration - -### 1.17.0 January 31, 2021 { id="1.17.0" } - -- Added support for section index pages - -### 1.16.1 January 26, 2021 { id="1.16.1" } - -- Fixed #2249: Instant loading + sticky tabs result in invalid links -- Fixed #2248: Search highlighting URL parameter always added -- Fixed #2235: Version selector doesn't select current version for aliases - -### 1.16.0 January 7, 2021 { id="1.16.0" } - -- Added latest release to repository info (GitHub) -- Slight facelift of repository info (lighter fonts, spacing and icons) - -### 1.15.0 January 2, 2021 { id="1.15.0" } - -- Added support for native Mermaid.js integration - -### 1.14.0 December 30, 2020 { id="1.14.0" } - -- Added support for sharing searches - -### 1.13.2 December 22, 2020 { id="1.13.2" } - -- Fixed version selector + sticky tabs navigation rendering issues -- Fixed version selector wrapping - -### 1.13.1 December 20, 2020 { id="1.13.1" } - -- Removed horizontal scrollbars on language and version selector -- Fixed type conversion in JavaScript config - -### 1.13.0 December 13, 2020 { id="1.13.0" } - -- Refactored navigation tabs to simplify grouping behavior -- Added support for sticky navigation tabs -- Added support for arbitrary links in navigation tabs -- Fixed #2098: Subsequent active subsection not highlighted correctly - -### 1.12.1 December 8, 2020 { id="1.12.1" } - -- Fixed empty language selector being shown - -### 1.12.0 December 6, 2020 { id="1.12.0" } - -- Added support for adding a language selector - -### 1.11.2 November 29, 2020 { id="1.11.2" } - -- Fixed #2068: Search highlight interprets code blocks as JavaScript - -### 1.11.1 November 29, 2020 { id="1.11.1" } - -- Refactored styling to be more stable and easier to adjust -- Fixed some styling regressions from latest features - -### 1.11.0 November 22, 2020 { id="1.11.0" } - -- Added support for rendering admonitions as inline blocks - -### 1.10.0 November 15, 2020 { id="1.10.0" } - -- Added support for integrating table of contents into navigation - -### 1.9.0 November 7, 2020 { id="1.9.0" } - -- Added support for hiding navigation and table of contents on any page -- Removed autohiding table of contents when empty - -### 1.8.0 November 1, 2020 { id="1.8.0" } - -- Added support for navigation sections -- Fixed appearance of inactive search suggestions - -### 1.7.0 October 25, 2020 { id="1.7.0" } - -- Added support for deploying multiple versions -- Fixed alignment of sidebar when content area is too small - -### 1.6.0 October 11, 2020 { id="1.6.0" } - -- Added support for search suggestions to save keystrokes -- Added support for removing __Made with Material for MkDocs__ from footer -- Fixed #1915: search should go to first result by pressing ++enter++ - -### 1.5.1 September 21, 2020 { id="1.5.1" } - -- Fixed content area stretching to whole width for long code blocks - -### 1.5.0 September 19, 2020 { id="1.5.0" } - -- Added support for autohiding table of contents when empty - -### 1.4.1 September 6, 2020 { id="1.4.1" } - -- Improved typeahead and search result relevance and scoring - -### 1.4.0 August 30, 2020 { id="1.4.0" } - -- Added support for autohiding header on scroll - -### 1.3.0 August 26, 2020 { id="1.3.0" } - -- Added support for user-selectable color palettes - -### 1.2.0 August 11, 2020 { id="1.2.0" } - -- Added feature to expand navigation by default - -### 1.1.0 August 3, 2020 { id="1.1.0" } - -- Added highlighting of search results - -### 1.0.0 July 14, 2020 { id="1.0.0" } - -- Added grouping of search results -- Added missing query terms to search result -- Improved search result relevance and scoring diff --git a/docs/insiders/getting-started.md b/docs/insiders/getting-started.md deleted file mode 100644 index 97dfaa21447..00000000000 --- a/docs/insiders/getting-started.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -title: Getting started with Insiders ---- - -# Getting started with Insiders - -Material for MkDocs Insiders is a compatible drop-in replacement for Material -for MkDocs, and can be installed similarly using [`pip`][pip], -[`docker`][docker] or [`git`][git]. - - [pip]: #with-pip - [docker]: #with-docker - [git]: #with-git - -## Requirements - -After you've been added to the list of collaborators and accepted the -repository invitation, the next step is to create a [personal access token] for -your GitHub account in order to access the Insiders repository programmatically -(from the command line or GitHub Actions workflows): - -1. Go to https://github.com/settings/tokens -2. Click on [Generate a new token] -3. Enter a name and select the [`repo`][scopes] scope -4. Generate the token and store it in a safe place - - [personal access token]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token - [Generate a new token]: https://github.com/settings/tokens/new - [scopes]: https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes - -Some of the instructions below require that the `GH_TOKEN` environment -variable is set to the value of the personal access token you -generated in the previous step. Note that the personal access token -must be kept secret at all times, as it allows the owner to access -your private repositories. - -## Installation - -### with pip - -Material for MkDocs Insiders can be installed with `pip`. You will -normally want to install the latest release but can also install a -specific older release or even the latest development version. -Make sure you have the `GH_TOKEN` variable set as instructed above. - -=== "Specific release" - - Pick the corresponding tag from the [list of tags] for the Insiders - repository. In the `pip` command below, replace the tag at the - end of the URL with the one you want. - - ``` sh - pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@9.4.2-insiders-4.42.0 - ``` - -=== "Latest" - - ``` sh - pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git - ``` - -[list of tags]: https://github.com/squidfunk/mkdocs-material-insiders/tags - -### with docker - -In case you want to use Material for MkDocs Insiders from within Docker, some -additional steps are necessary. While we cannot provide a hosted Docker image -for Insiders[^2], [GitHub Container Registry] allows for simple and -comfortable self-hosting: - -1. [Fork the Insiders repository] -2. Enable [GitHub Actions] on your fork[^3] -3. Create a new personal access token[^4] - 1. Go to https://github.com/settings/tokens - 2. Click on [Generate a new token] - 3. Enter a name and select the [`write:packages`][scopes] scope - 4. Generate the token and store it in a safe place -4. Add a [GitHub Actions secret] on your fork - 1. Set the name to `GHCR_TOKEN` - 2. Set the value to the personal access token created in the previous step -5. [Create a new release] to build and publish the Docker image -6. Install [Pull App] on your fork to stay in-sync with upstream - -The [`build`][build] workflow is automatically run when a new tag -(release) is created. When a new Insiders version is released on the upstream -repository, the [Pull App] will create a pull request with the changes and -pull in the new tag, which is picked up by the [`build`][build] workflow -that builds and publishes the Docker image automatically to your private -registry. - -Now, you should be able to pull the Docker image from your private registry: - -``` -docker login -u ${GH_USERNAME} -p ${GHCR_TOKEN} ghcr.io -docker pull ghcr.io/${GH_USERNAME}/mkdocs-material-insiders -``` - -Should you wish to add additional plugins to the insiders container image, follow the steps -outlined in the [Getting Started guide](../getting-started.md#with-docker). - - [^2]: - Earlier, Insiders provided a dedicated Docker image which was available to - all sponsors. On March 21, 2021, the image was deprecated for the reasons - outlined and discussed in #2442. It was removed on June 1, 2021. - - [^3]: - When forking a repository, GitHub will disable all workflows. While this - is a reasonable default setting, you need to enable GitHub Actions to be - able to automatically build and publish a Docker image on - [GitHub Container Registry]. - - [^4]: - While you could just add the `write:packages` scope to the personal access - token created to access the Insiders repository, it's safer to create a - dedicated token which you'll only use for publishing the Docker image. - -### with git - -Of course, you can use Material for MkDocs Insiders directly from `git`: - -``` -git clone git@github.com:squidfunk/mkdocs-material-insiders.git mkdocs-material -``` - -The theme will reside in the folder `mkdocs-material/material`. When cloning -from `git`, the theme must be installed, so MkDocs can find the built-in -plugins: - -``` -pip install -e mkdocs-material -``` - - [GitHub Container Registry]: https://docs.github.com/en/packages/guides/about-github-container-registry - [Fork the Insiders repository]: https://github.com/squidfunk/mkdocs-material-insiders/fork - [GitHub Actions]: https://docs.github.com/en/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository - [packages scope]: https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes - [GitHub Actions secret]: https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository - [Create a new release]: https://docs.github.com/en/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release - [Pull App]: https://github.com/apps/pull - [build]: https://github.com/squidfunk/mkdocs-material-insiders/blob/master/.github/workflows/build.yml - -## Built-in plugins - -When you're using built-in plugins that are solely available via Insiders, -outside contributors won't be able to build your documentation project on their -local machine. This is the reason why we developed the [built-in group plugin] -that allows to conditionally load plugins: - -``` yaml -plugins: - - search - - social - - # CI=true mkdocs build - - group: - enabled: !ENV CI - plugins: - - git-revision-date-localized - - git-committers - - # INSIDERS=true mkdocs build - - group: - enabled: !ENV INSIDERS - plugins: - - optimize - - privacy -``` - -Of course, you can also enable both groups with: - -``` shell -CI=true INSIDERS=true mkdocs build -``` - - [built-in group plugin]: ../plugins/group.md - [configuration inheritance]: https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance diff --git a/docs/insiders/index.md b/docs/insiders/index.md deleted file mode 100644 index c7b57089071..00000000000 --- a/docs/insiders/index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -template: redirect.html -location: getting-started/ ---- diff --git a/docs/insiders/upgrade.md b/docs/insiders/upgrade.md deleted file mode 100644 index ec86ad9701a..00000000000 --- a/docs/insiders/upgrade.md +++ /dev/null @@ -1,79 +0,0 @@ -# How to upgrade - -When upgrading Insiders, you should always check the version of Material for -MkDocs which makes up the first part of the version qualifier, e.g., Insiders -`4.x.x` is currently based on `9.x.x`: - -``` -9.x.x-insiders-4.x.x -``` - -If the major version increased, it's a good idea to consult the [upgrade -guide] and go through the steps to ensure your configuration is up to date and -all necessary changes have been made. - - [upgrade guide]: ../upgrade.md - [list of tags]: https://github.com/squidfunk/mkdocs-material-insiders/tags - -Depending on how you installed and what you want to upgrade to you -need to run different commands: - -=== "pip upgrade to release" - - If you installed Insiders via `pip` and you want to upgrade to a - specific release, pick the tag from the [list of tags] and replace - the tag at the end of the URL of the command given below: - - ``` - pip install --upgrade git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@9.4.2-insiders-4.42.0 - ``` - -=== "pip upgrade to latest development" - - If you installed Insiders via `pip` and want to upgrade to the - latest development version, run: - - ``` - pip install --upgrade --force-reinstall git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git - ``` - - The `--force-reinstall` option serves to make sure `pip` does, in fact, - install the latest development version, instead of deciding that nothing - is to be done based on the version numbers. - ``` - -=== "git upgrade" - - If you installed Insiders via `git`, you will first need to check - out the version you want to install into your workspace. After - this is done, you can run `pip` to install that version. - - First, make sure that your local clone is up-to-date with the - upstream repository by running `git pull`. - - You can look up the tags using `git tag --sort -refname` or you - can consult the [list of tags]. Then, checkout the tag you want to - use by replacing the one given in the command below (twice)and running - it from your workspace[^detached]: - - [^detached]: - The `--detach` argument serves to tell `git` that you are ok to - have your workspace in the [detached head] state, which is - perfectly fine to have here. - - [detached head]: https://www.git-tower.com/learn/git/faq/detached-head-when-checkout-commit/ - - ``` - cd mkdocs-material - git checkout --detach tags/9.4.2-insiders-4.42.0 - ``` - - Now, change back to the parent directory in which your Git - repository lives and run `pip`: - - ``` - cd .. - pip install -e mkdocs-material - ``` - - diff --git a/docs/plugins/projects.md b/docs/plugins/projects.md index 3038e8b8978..69953827555 100644 --- a/docs/plugins/projects.md +++ b/docs/plugins/projects.md @@ -24,7 +24,7 @@ be used to split very large projects into smaller parts. [Material for MkDocs is in maintenance mode]: https://github.com/squidfunk/mkdocs-material/issues/8523 [Zensical]: ../blog/posts/zensical.md - [Insiders]: ../insiders/index.md + [Insiders]: ../blog/posts/insiders-now-free-for-everyone.md ## Objective diff --git a/docs/plugins/typeset.md b/docs/plugins/typeset.md index f2437478e7c..8712440c37a 100644 --- a/docs/plugins/typeset.md +++ b/docs/plugins/typeset.md @@ -24,7 +24,7 @@ as defined in the page's content. [Material for MkDocs is in maintenance mode]: https://github.com/squidfunk/mkdocs-material/issues/8523 [Zensical]: ../blog/posts/zensical.md - [Insiders]: ../insiders/index.md + [Insiders]: ../blog/posts/insiders-now-free-for-everyone.md ## Objective diff --git a/material/overrides/hooks/shortcodes.py b/material/overrides/hooks/shortcodes.py index d3ccd3ff9ae..7ce37be3d24 100644 --- a/material/overrides/hooks/shortcodes.py +++ b/material/overrides/hooks/shortcodes.py @@ -124,9 +124,9 @@ def _badge(icon: str, text: str = "", type: str = ""): # Create sponsors badge def _badge_for_sponsors(page: Page, files: Files): icon = "material-heart" - href = _resolve_path("insiders/index.md", page, files) + href = _resolve_path("blog/posts/insiders-now-free-for-everyone.md", page, files) return _badge( - icon = f"[:{icon}:]({href} 'Sponsors only')", + icon = f"[:{icon}:]({href} 'Former Insiders feature')", type = "heart" ) @@ -146,11 +146,11 @@ def _badge_for_version(text: str, page: Page, files: Files): # Create badge for version of Insiders def _badge_for_version_insiders(text: str, page: Page, files: Files): spec = text.replace("insiders-", "") - path = f"insiders/changelog/index.md#{spec}" + path = "blog/posts/insiders-now-free-for-everyone.md" # Return badge icon = "material-tag-heart-outline" - href = _resolve_path("conventions.md#version-insiders", page, files) + href = _resolve_path(path, page, files) return _badge( icon = f"[:{icon}:]({href} 'Minimum version')", text = f"[{text}]({_resolve_path(path, page, files)})" if spec else "" diff --git a/mkdocs.yml b/mkdocs.yml index 5e251930d39..4ded873cd4a 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -97,6 +97,12 @@ plugins: separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])' - redirects: redirect_maps: + insiders/index.md: blog/posts/insiders-now-free-for-everyone.md + insiders/getting-started.md: blog/posts/insiders-now-free-for-everyone.md + insiders/upgrade.md: blog/posts/insiders-now-free-for-everyone.md + insiders/changelog/index.md: blog/posts/insiders-now-free-for-everyone.md + changelog/insiders.md: blog/posts/insiders-now-free-for-everyone.md + sponsorship.md: blog/posts/insiders-now-free-for-everyone.md philosophy.md: getting-started.md tutorials/index.md: setup/index.md tutorials/blogs/basic.md: setup/setting-up-a-blog.md @@ -257,12 +263,6 @@ nav: - Lists: reference/lists.md - Math: reference/math.md - Tooltips: reference/tooltips.md - - Insiders: - - insiders/index.md - - Getting started: insiders/getting-started.md - - Changelog: - - insiders/changelog/index.md - - How to upgrade: insiders/upgrade.md - Community: - Contributing: - contributing/index.md diff --git a/src/overrides/hooks/shortcodes.py b/src/overrides/hooks/shortcodes.py index d3ccd3ff9ae..7ce37be3d24 100644 --- a/src/overrides/hooks/shortcodes.py +++ b/src/overrides/hooks/shortcodes.py @@ -124,9 +124,9 @@ def _badge(icon: str, text: str = "", type: str = ""): # Create sponsors badge def _badge_for_sponsors(page: Page, files: Files): icon = "material-heart" - href = _resolve_path("insiders/index.md", page, files) + href = _resolve_path("blog/posts/insiders-now-free-for-everyone.md", page, files) return _badge( - icon = f"[:{icon}:]({href} 'Sponsors only')", + icon = f"[:{icon}:]({href} 'Former Insiders feature')", type = "heart" ) @@ -146,11 +146,11 @@ def _badge_for_version(text: str, page: Page, files: Files): # Create badge for version of Insiders def _badge_for_version_insiders(text: str, page: Page, files: Files): spec = text.replace("insiders-", "") - path = f"insiders/changelog/index.md#{spec}" + path = "blog/posts/insiders-now-free-for-everyone.md" # Return badge icon = "material-tag-heart-outline" - href = _resolve_path("conventions.md#version-insiders", page, files) + href = _resolve_path(path, page, files) return _badge( icon = f"[:{icon}:]({href} 'Minimum version')", text = f"[{text}]({_resolve_path(path, page, files)})" if spec else "" From 245df5a3ec8d7773fe5617c9b53293d3e7335fdf Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sat, 17 Oct 2026 20:14:57 +0200 Subject: [PATCH 2/2] Updated Zensical transition blog posts Signed-off-by: squidfunk --- docs/blog/posts/goodbye-github-discussions.md | 37 +++++++++++----- .../posts/insiders-now-free-for-everyone.md | 37 +++++++++++----- docs/blog/posts/mkdocs-2.0.md | 6 +++ .../posts/transforming-material-for-mkdocs.md | 10 +++++ docs/blog/posts/zensical.md | 44 ++++++++++++++----- 5 files changed, 98 insertions(+), 36 deletions(-) diff --git a/docs/blog/posts/goodbye-github-discussions.md b/docs/blog/posts/goodbye-github-discussions.md index dc3e1db2fe5..6611c7e3dad 100644 --- a/docs/blog/posts/goodbye-github-discussions.md +++ b/docs/blog/posts/goodbye-github-discussions.md @@ -28,6 +28,22 @@ _You can subscribe to [our newsletter] to stay in the loop_. +!!! info "October 2026 update" + + This article records our November 2025 decision to make Material for MkDocs' + GitHub Discussions read-only. Existing answers remain available. + + For Zensical questions and community discussion, our free [Discord] remains + open. Bugs and feature requests belong in the [public Zensical issue tracker]. + + [Spark](https://zensical.org/spark/) offers focused professional exchange + and selected early access, with organization memberships for direct support. + Spark Community opens to individuals on **November 5, 2026**. Public + discussion, bug reporting, and contributions remain free. + + [public Zensical issue tracker]: https://github.com/zensical/zensical/issues + [migration guide]: https://zensical.org/docs/compatibility/mkdocs/migration/ + [Our new approach]: https://zensical.org/docs/community/how-we-work/ [maintenance mode]: https://github.com/squidfunk/mkdocs-material/issues/8523 [Zensical]: https://zensical.org @@ -102,18 +118,15 @@ With Material for MkDocs in [maintenance mode], __our GitHub Discussion board is !!! warning "Material for MkDocs is in maintenance mode" - We want to be transparent about the risks of staying on Material for MkDocs - or on forks of both Material for MkDocs and MkDocs. With MkDocs 1.x - unmaintained and facing fundamental supply chain concerns, its future is - uncertain and we cannot guarantee Material for MkDocs will continue working - reliably. MkDocs 2.0 will introduce breaking changes – - something we [analyzed thoroughly in our MkDocs 2.0 article]. - - We're aware that transitioning takes time, which is why we commit to - supporting Material for MkDocs for at least the next 12 months, fixing - critical bugs and security vulnerabilities as needed. If you have questions - about your specific situation or need help planning a migration, don't - hesitate to reach out at hello@zensical.org. + Feature development has ended. We will continue fixing critical bugs and + security vulnerabilities through **May 5, 2027**, when upstream maintenance + ends. Existing installations and published sites can still be used afterward. + + The [migration guide] explains how to build your current project with + Zensical alongside MkDocs, so you can check that it works as expected + before switching. We also recommend reading our article on + [what MkDocs 2.0 means for your documentation projects][analyzed thoroughly in our MkDocs 2.0 article] + to help you plan your next steps. [analyzed thoroughly in our MkDocs 2.0 article]: mkdocs-2.0.md diff --git a/docs/blog/posts/insiders-now-free-for-everyone.md b/docs/blog/posts/insiders-now-free-for-everyone.md index d848a00f53f..f58fe42a5ee 100644 --- a/docs/blog/posts/insiders-now-free-for-everyone.md +++ b/docs/blog/posts/insiders-now-free-for-everyone.md @@ -32,6 +32,22 @@ _You can subscribe to [our newsletter] to stay in the loop_. +!!! info "October 2026 update" + + This article records the November 2025 release of all Insiders features. + These features are available in the public `mkdocs-material` package, + without sponsorship or private-repository access. + + Critical maintenance now continues through **May 5, 2027**. This supersedes + the original twelve-month window mentioned below; feature development + has ended. + + Zensical now builds supported Material for MkDocs projects with their + existing content and `mkdocs.yml`. Our [migration guide] explains how to + run it alongside MkDocs and check your site before switching. + + [migration guide]: https://zensical.org/docs/compatibility/mkdocs/migration/ + [9.7.0]: ../../changelog/index.md#9.7.0 [Zensical]: https://zensical.org [maintenance mode]: https://github.com/squidfunk/mkdocs-material/issues/8523 @@ -151,18 +167,15 @@ Material for MkDocs grew organically like a plant in a pot that eventually becam !!! warning "Material for MkDocs is in maintenance mode" - We want to be transparent about the risks of staying on Material for MkDocs - or on forks of both Material for MkDocs and MkDocs. With MkDocs 1.x - unmaintained and facing fundamental supply chain concerns, its future is - uncertain and we cannot guarantee Material for MkDocs will continue working - reliably. MkDocs 2.0 will introduce breaking changes – - something we [analyzed thoroughly in our MkDocs 2.0 article]. - - We're aware that transitioning takes time, which is why we commit to - supporting Material for MkDocs for at least the next 12 months, fixing - critical bugs and security vulnerabilities as needed. If you have questions - about your specific situation or need help planning a migration, don't - hesitate to reach out at hello@zensical.org. + Feature development has ended. We will continue fixing critical bugs and + security vulnerabilities through **May 5, 2027**, when upstream maintenance + ends. Existing installations and published sites can still be used afterward. + + The [migration guide] explains how to build your current project with + Zensical alongside MkDocs, so you can check that it works as expected + before switching. We also recommend reading our article on + [what MkDocs 2.0 means for your documentation projects][analyzed thoroughly in our MkDocs 2.0 article] + to help you plan your next steps. [analyzed thoroughly in our MkDocs 2.0 article]: mkdocs-2.0.md diff --git a/docs/blog/posts/mkdocs-2.0.md b/docs/blog/posts/mkdocs-2.0.md index ba0809ef2bb..b18c5dec321 100644 --- a/docs/blog/posts/mkdocs-2.0.md +++ b/docs/blog/posts/mkdocs-2.0.md @@ -191,6 +191,12 @@ _If you have any questions, feel free to reach out to Kathi at hello@zensical.or [licensed under MIT]: https://www.encode.io/mkdocs/license/ [licensing might change in the future]: https://github.com/encode/mkdocs/issues/58 +### September 2026 + +- __September 16, 2026__: We [announced a six-month extension][upcoming changes article] of Material for MkDocs' critical maintenance through **May 5, 2027**, giving teams more time to evaluate Zensical and plan their transition. + + [upcoming changes article]: https://zensical.org/upcoming-changes/ + ### August 2026 - __August 30, 2026__: MkDocs 2.0 was just published as a [pre-release on PyPI](https://pypi.org/project/mkdocs/2.0.dev2/). No official release date has been announced yet, but the pre-release hints that it might be coming soon. diff --git a/docs/blog/posts/transforming-material-for-mkdocs.md b/docs/blog/posts/transforming-material-for-mkdocs.md index 4390aec5c94..db6f0042d0f 100644 --- a/docs/blog/posts/transforming-material-for-mkdocs.md +++ b/docs/blog/posts/transforming-material-for-mkdocs.md @@ -21,6 +21,16 @@ This article is part of a series where we'll explore how we aim to support our u +!!! info "October 2026 update" + + The work outlined in this August 2024 article led to + [Zensical](https://zensical.org/), our successor to Material for MkDocs. + The article below records our goals and plans at the time. + + Our [roadmap](https://zensical.org/roadmap/) describes the current direction; + the [MkDocs compatibility guide](https://zensical.org/docs/compatibility/mkdocs/) + covers supported features and plugins. + _Please note that this post includes several technical details in the footnotes, specifically on challenges. Feel free to skip them if you're not interested in the specifics._ --- diff --git a/docs/blog/posts/zensical.md b/docs/blog/posts/zensical.md index 961dd14cf11..1c0aa2c8429 100644 --- a/docs/blog/posts/zensical.md +++ b/docs/blog/posts/zensical.md @@ -32,6 +32,29 @@ _You can subscribe to [our newsletter] to stay in the loop_. +!!! info "October 2026 update" + + Zensical now builds supported Material for MkDocs projects with their + existing content and `mkdocs.yml`. Follow the [migration guide] to run it + alongside MkDocs and check your site before switching. + + [Zensical Studio][Studio] brings live preview, diagnostics, and project + navigation to Visual Studio Code and similar editors. It works with both + Zensical and MkDocs, so you can keep using it throughout the transition. + + On **November 5, 2026**, Zensical 0.1 begins a dependable release line, + Studio leaves beta, and Spark Community opens to individuals. + [See what changes](https://zensical.org/upcoming-changes/). + Material's critical maintenance continues through **May 5, 2027**. + + This article records our November 2025 launch. Some plans have since + changed, including the Markdown toolchain: we are now developing a + Python Markdown-compatible parser. See the [current roadmap](https://zensical.org/roadmap/) + for progress and direction. + + [migration guide]: https://zensical.org/docs/compatibility/mkdocs/migration/ + [Studio]: https://zensical.org/studio/ + [Zensical]: https://zensical.org/ [compatibility]: #maximum-compatibility [Zensical Spark]: #zensical-spark @@ -216,18 +239,15 @@ Material for MkDocs grew organically like a plant in a pot that eventually becam !!! warning "Material for MkDocs is in maintenance mode" - We want to be transparent about the risks of staying on Material for MkDocs - or on forks of both Material for MkDocs and MkDocs. With MkDocs 1.x - unmaintained and facing fundamental supply chain concerns, its future is - uncertain and we cannot guarantee Material for MkDocs will continue working - reliably. MkDocs 2.0 will introduce breaking changes – - something we [analyzed thoroughly in our MkDocs 2.0 article]. - - We're aware that transitioning takes time, which is why we commit to - supporting Material for MkDocs for at least the next 12 months, fixing - critical bugs and security vulnerabilities as needed. If you have questions - about your specific situation or need help planning a migration, don't - hesitate to reach out at hello@zensical.org. + Feature development has ended. We will continue fixing critical bugs and + security vulnerabilities through **May 5, 2027**, when upstream maintenance + ends. Existing installations and published sites can still be used afterward. + + The [migration guide] explains how to build your current project with + Zensical alongside MkDocs, so you can check that it works as expected + before switching. We also recommend reading our article on + [what MkDocs 2.0 means for your documentation projects][analyzed thoroughly in our MkDocs 2.0 article] + to help you plan your next steps. [analyzed thoroughly in our MkDocs 2.0 article]: mkdocs-2.0.md