Skip to content

Align documentation theme with other Pydantic libraries #1558

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

Open
Viicos wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Align documentation theme with other Pydantic libraries #1558

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 2 additions & 22 deletions docs/extra/tweaks.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,8 @@
/* https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#custom-colors */
:root {
--md-primary-fg-color: #e620e9;
--md-primary-fg-color--light: #e620e9;
--md-primary-fg-color--dark: #e620e9;
/* this color is used by the announce banner: */
--md-footer-bg-color: #1d0214;
}

/* Revert hue value to that of pre mkdocs-material v9.4.0 */
[data-md-color-scheme="slate"] {
/* Hue taken from hsl of #1d0214, used for bg on website*/
--md-hue: 320;
/* Increase the lightness by 5%, opacity by 0.2 */
--md-default-fg-color: hsla(var(--md-hue),15%,95%,1.0);
--md-default-fg-color--light: hsla(var(--md-hue),15%,95%,0.76);
--md-default-fg-color--lighter: hsla(var(--md-hue),15%,95%,0.52);
--md-default-fg-color--lightest: hsla(var(--md-hue),15%,95%,0.32);
/* Change the saturation and lightness to match #1d0214 */
--md-default-bg-color: hsla(var(--md-hue),87%,6%,1);
--md-default-bg-color--light: hsla(var(--md-hue),87%,6%,0.54);
--md-default-bg-color--lighter: hsla(var(--md-hue),87%,6%,0.26);
--md-default-bg-color--lightest: hsla(var(--md-hue),87%,6%,0.07);
/* Increase the opacity of code to 1.0 */
--md-code-fg-color: hsla(var(--md-hue),18%,86%,1.0)
--md-hue: 230;
--md-default-bg-color: hsla(230, 15%, 21%, 1);
}

.custom-source-wrapper {
Expand Down
20 changes: 13 additions & 7 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,26 @@ theme:
name: "material"
custom_dir: "docs/overrides"
palette:
- media: "(prefers-color-scheme)"
primary: pink
accent: pink
toggle:
icon: material/brightness-auto
name: "Switch to light mode"
- media: "(prefers-color-scheme: light)"
scheme: default
primary: custom
accent: custom
primary: pink
accent: pink
toggle:
icon: material/lightbulb-outline
icon: material/brightness-7
name: "Switch to dark mode"
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom
accent: custom
primary: pink
accent: pink
toggle:
icon: material/lightbulb
name: "Switch to light mode"
icon: material/brightness-4
name: "Switch to system preference"
features:
- search.suggest
- search.highlight
Expand Down
Loading