Upgrading¶
Upgrade in your documentation environment, then build and preview before publishing:
python -m pip install --upgrade mkdocs-pixel-lab
python -m mkdocs build --strict
python -m mkdocs serve
Check release notes for the version you're adopting. Projects with pinned dependencies should update their pin or lockfile through their normal workflow.
Moving to 0.2¶
Heading permalinks¶
Remove the obsolete theme.permalink_icon and theme.permalink_fill_color
settings and use Python-Markdown's toc configuration instead. See
Heading permalinks for setup.
Page and repository actions¶
repo_url controls the repository button. Available page source and edit
actions are shown by default; choose show_repo, show_source, and
show_edit independently if your site should hide any of them. Use
show_repo_name: false for an icon-only repository button.
For setup, see Repository link and Source and edit links; for artwork, see Icons.
Related-site navigation¶
Use extra.site_navigation.header_mode with dropdown, inline, or none
instead of the previous show_header / show_dropdown flags. Header modes
don't render together; show_footer remains independent. See Related sites.
Preview checklist¶
- Verify navigation and toolbar actions on desktop and a narrow screen.
- Check source/edit URLs against the deployed branch.
- Try keyboard focus, Escape, search, and content tabs.
- Review custom colors and icons for contrast and sizing.
- Recheck any CSS or template overrides against the current theme.