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)

0.0.2

Summary

This releases fixes all currently known issues and ships dozens of new icons, bringing the user experience of the modern theme closer to parity with the classic theme.

Highlights

• Add GitHub repository in drawer on mobile in modern theme
• Add 132 new icons (and delete 44 icons, as Simple icons removed them)
• Fix issues related to keyboard shortcuts (printing and search input)
• Fix language selector escaping viewport on mobile when too wide

Changelog

Breaking changes

• 9b8b9f3 ui – upgrade Simple icons to 16.2.0 with 37 new icons and 44 deleted icons

Features

• 57ab8a6 ui – upgrade Octicons to 19.21.1 with 50 new icons
• 3cbcbbb ui – upgrade Lucide icons to 0.562.0 with 45 new icons
• d8ca487 ui, scripts, tools – add third-party licenses to distribution files (#1)

Bug fixes

• d66c230 ui, modern – git repository not shown in sidebar on mobile in modern theme (#6)
• b10637d ui, classic, modern – language selector escapes viewport when too wide on mobile (#14)
• 6f240e2 ui, scripts – search can receive keyboard input after being closed (#10)
• fa23b1c ui, classic – header buttons disappear on mobile when opening search in classic theme (#16)
• 214b03c ui, scripts – instant navigation doesn't trigger on keyboard shortcuts p and n (#10)
• fbc78ac ui, modern – modernize kbd (keyboard shortcut) styles (#11, #28)
• fcad2b0 ui, scripts – print dialog doesn't open when meta + pis pressed (#25)

Refactorings

• 1e298ee ui, modern – use px2rem for kbd styles

0.0.1

Initial release