Skip to content

Switch to mkdocs material theme for documentation #9849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
browniebroke wants to merge 16 commits into
base: main
Choose a base branch
from
Draft

Switch to mkdocs material theme for documentation #9849

browniebroke wants to merge 16 commits into from
+192 −59

Conversation

@browniebroke
Copy link
Member

@browniebroke browniebroke commented Dec 15, 2025

Description

Explore replacing our theme by mkdocs-material.

Light theme:

image

Dark theme:

image

Some things I'm not happy about:

  • I think the colors for the dark theme aren't quite there yet (especially the contrast of the links).
  • Syntax highlighting for code snippets is lost unless we switch to code fences (no idea how it works now)
  • This theme has a lot of features, there might be more to enable
@auvipy auvipy self-requested a review December 15, 2025 19:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant

@browniebroke