Skip to content

Add dark mode, versioned docs, navigation tabs, and PR validation - #5

Merged
biplovbhandari merged 2 commits into
mainfrom
docs/mkdocs-template-upgrade
Sep 3, 2026
Merged

biplovbhandari merged 2 commits into
mainfrom
docs/mkdocs-template-upgrade

Conversation

@biplovbhandari

Copy link
Copy Markdown
Member

Summary

  • Add dark mode toggle (default/slate schemes).
  • Add versioned docs via mike (version switcher dropdown, dev/latest on push to main, versioned deploy on tag push).
  • Restructure nav into tabs: Home, Guide, API Reference, Notebooks.
  • Add PR validation build (mkdocs build --strict) to catch errors before merge.
  • Add edit page pencil icon, search autocomplete, content tooltips.
  • Add extensions: attr_list, md_in_html, pymdownx.snippets, pymdownx.tasklist.
  • Add mike to requirements-docs.txt.

Validation

  • Local build and mike serve verified: tabs, dark mode, version switcher, edit icon all working.

@biplovbhandari
biplovbhandari merged commit e1bff6a into main Sep 3, 2026
5 checks passed
@biplovbhandari
biplovbhandari deleted the docs/mkdocs-template-upgrade branch September 3, 2026 17:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant