Skip to content

docs: switch theme from mkdocs-material to mkdocs-shadcn #111

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

Closed
flaport wants to merge 2 commits into from
Closed

docs: switch theme from mkdocs-material to mkdocs-shadcn #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec39869
docs: switch theme from material to mkdocs-shadcn
flaport May 3, 2026
790a135
docs: add pygments_style and crossref_modules to shadcn theme config
flaport May 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 14 additions & 42 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,35 +7,18 @@ repo_name: flaport/sax
copyright: Copyright © 2025, Floris Laporte, Apache-2.0

theme:
name: material
name: shadcn
logo: assets/logo.svg
favicon: assets/favicon.ico
font:
text: Roboto
code: Roboto Mono
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/weather-sunny
name: Switch to dark mode
primary: blue
accent: deep purple
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/weather-night
name: Switch to system default
primary: blue
accent: deep purple
features:
- content.code.copy
- navigation.footer
search: true
pygments_style:
light: shadcn-light
dark: github-dark
katex_options: {}
crossref_modules:
- sax
- sax.fit
- sax.models
- sax.models.rf

nav:
- home: index.md
Expand Down Expand Up @@ -65,12 +48,6 @@ nav:
- sax.models.rf: models_rf.md
- changelog: changelog.md

extra_css:
- assets/custom.css

extra_javascript:
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

plugins:
- search
- autorefs
Expand Down Expand Up @@ -118,7 +95,8 @@ markdown_extensions:
- footnotes
- toc:
permalink: true
- pymdownx.emoji
- pymdownx.arithmatex:
generic: true
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
Expand All @@ -128,16 +106,10 @@ markdown_extensions:
- pymdownx.magiclink
- pymdownx.tabbed:
alternate_style: true
- pymdownx.superfences
- admonition
- pymdownx.details
- pymdownx.arithmatex:
generic: true
- pymdownx.superfences
- pymdownx.emoji

hooks:
- docs/hooks.py

extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/flaport
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ docs = [
"mkautodoc>=0.2.0,<0.3.0",
"mkdocs-autorefs>=1.4.4,<1.5.0",
"mkdocs-bibtex>=4.4.0,<5.0.0",
"mkdocs-material>=9.7.6,<10.0.0",
"mkdocs-shadcn @ git+https://github.com/gdsfactory/mkdocs-shadcn.git",
"mkdocs-matplotlib>=0.10.1,<0.11.0",
"mkdocs>=1.6.1,<2.0.0",
"mkdocstrings[python]>=1.0.4,<2.0.0",
Expand Down
Loading