0.0.12

Summary

This version includes breaking changes for icons, as Lucide has been updated to v1, which includes the removal of 19 brand icons. 166 new icons are added, most of them brand icons in SimpleIcons and FontAwesome. Additionally, there are bug fixes related to the latest changes of the table of contents in the modern theme and instant navigation on anchor links.

In case you were using any of the removed icons, we recommend switching to the equivalent icon from the SimpleIcons or FontAwesome icon sets.

Changelog

Breaking changes

• 4e8623e ui – update dependencies, 166 icons added, 19 icons removed

Bug fixes

• b16b8a8 ui, templates – toc.integrate broken in modern theme (0.0.11 regression) (#111)
• 5ba2e25 ui, scripts – instant navigation triggers on anchor link (#93)
• 3cbe454 ui, templates – don't show button on mobile if table of contents is empty

0.0.11

Summary

This version ships a new table of contents implementation for the mobile view in the modern theme in form of a floating sidebar. The button is located at the bottom, so it's easily reachable with the thumb, and the sidebar itself is scrollable, so it can accommodate arbitrarily long tables of contents.

Additionally, it includes several tweaks to make the user interface more snappy and improve readability of tooltips and inline code blocks.

Changelog

Features

• ca469e0 ui, modern, scripts, templates – add floating table of contents in mobile view (#105)

Bug fixes

• 5a9ed0f ui, classic, modern – weird line breaks added when copying code blocks in FireFox (#92)

Refactorings

• 07f3244 modern – increase font size of tooltips and decrease weight
• f5f8137 modern – decrease animation duration of sidebar for snappiness
• 2796dd3 modern – decrease size of buttons to align with surrounding content
• 6c80b69 modern – increase area of inline code blocks to improve readability

0.0.10

Summary

This version adds support for a version selector, a requirement for supporting mike to manage multiple versions of documentation on GitHub Pages. Additionally, it fixes a couple of bugs related to search and code annotation rendering.

Changelog

Features

• 3eb364c ui, modern, templates – add version selector support

Bug fixes

• 861c693 ui, scripts – search doesn't honor IME composition events (#90)
• d000c5c ui, scripts – search for control characters can break rendering (#96)
• b41536b ui, classic – code annotation in first line overlaid by code block controls (#71)

0.0.9

Summary

This version improves on accessibility and fixes some rendering bugs. Additionally, it simplifies customization of tags with additional styles, and fixes a bug with search highlighting when using keyboard navigation.

Changelog

Bug fixes

• 2d80c5c ui, modern – code annotation in first line overlaid by code block controls (#71)
• bf2d9b2 ui, scripts – search terms not highlighted on keyboard navigation (#77)
• 674a877 ui, templates – use site_name as alt for logo (#79)
• 745bed5 ui, templates – add missing aria-label to label elements (#79)
• 9775ab2 ui, templates – skip link doesn't work when no h1 is present in Markdown (#79)

Refactorings

• 3808055 ui, modern – improve spacing of tags and simplify customizations (#82)

0.0.8

Summary

This version fixes instant previews for Chinese and other non-ASCII languages, and mitigates layout shifts when switching from short to long pages in the modern theme.

Changelog

Bug fixes

• 641532f ui, scripts – switch search shadow mode to open (#72)
• bb0907e ui, scripts – instant preview not showing for non-ASCII anchors (#74)
• 85fc426 ui, modern – display function instead of func for relevant Python symbols (#67)
• 9774a36 ui, modern – add scrollbar-gutter to mitigate layout shifts (#69)

0.0.7

Summary

This version fixes two bugs for search, where exiting search on mobile would make the page unscrollable, and where scrolling would chain to the entire page on mobile.

Changelog

Bug fixes

• 047e3e7 ui, scripts – exiting search makes page unscrollable on mobile (#62)
• dd847f3 ui, classic, modern – set overscroll-behavior on sidebar to omit scroll-chaining (#61)

0.0.6

Summary

This version fixes several bugs, including fixing excessive memory usage for pages with hundreds of links that are marked with data-preview (for instant previews), and moves the back-to-top button to the bottom in the modern theme.

Changelog

Bug fixes

• 7bd7eef ui, scripts – instant previews fetch same URL multiple times (#55)
• 2455c47 ui, templates – view button invalid if blob or edit contained in path (#52)
• 822599d ui, scripts – code block copy button not working in offline mode (#53)

Refactorings

• 05ef77d ui, modern – move back-to-top button to the bottom (#49)

0.0.5

Summary

This version fixes the double-underline issue on API cross-references as generated by mkdocstrings.

Changelog

Bug fixes

• bbd1b48 ui, classic, modern – remove double-underline on autorefs

0.0.4

Summary

This version fixes an issue where & characters appear as & in the search input field, as well as the appearance of icons from the Lucide icon set when used with social links.

Changelog

Bug fixes

• 0a78e7e ui, scripts – search unescapes & characters in input field (#43)
• 5ad8a34 ui, classic, modern – icons in footer from Lucide icon set filled (#40)

0.0.3

Summary

This release adds support for fuzzy matching in the search interface. If one of the entered search terms yields no results, that search term is automatically matched fuzzily against all known terms in the index. This allows for more flexible searching, accommodating typos and variations in spelling. Fuzzy search is currently experimental. If you have feedback or encounter any issues, please let us know!

Highlights

• Add fuzzy search support for terms that yield no results
• Improve tooltip behavior on touch devices

Changelog

Features

• 13cff5c ui, scripts – add experimental fuzzy search

Bug fixes

• b589799 ui, scripts – palette tooltip overlays title when scrolling on mobile (#35)