Skip to content

Commit

Permalink
docs: Apply corporate design to repo-specific standalone docs (#3415)
Browse files Browse the repository at this point in the history
  • Loading branch information
BalduinLandolt authored Nov 5, 2024
1 parent 263e6a4 commit f398bf8
Show file tree
Hide file tree
Showing 6 changed files with 146 additions and 9 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ dependencies.txt
# exclude python virtual environments used for serving docs locally
env/
venv/
.venv/

# exclude generated openapi
docs/03-endpoints/generated-openapi/*
Expand Down
File renamed without changes.
28 changes: 28 additions & 0 deletions docs/assets/css/theme.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
[data-md-color-scheme="default"] {
--md-primary-fg-color: rgb(33, 68, 95);
--md-accent-fg-color: rgb(0, 94, 84);
/* --md-default-bg-color: rgb(235, 235, 235); */
}

[data-md-color-scheme="slate"] {
--md-primary-fg-color: rgb(116, 162, 207);
--md-accent-fg-color: rgb(0, 94, 84);
--md-default-bg-color: rgb(36, 37, 46);
}

.md-header,
.md-tabs {
background-color: rgb(33, 68, 95) !important;
}

.md-content a {
text-decoration: underline;
}

h1,
h2,
h3,
h4 {
font-weight: bold;
padding-top: 50px;
}
96 changes: 96 additions & 0 deletions docs/assets/icons/logo_bw.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 0 additions & 3 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
mkdocs
mkdocs-material
mkdocs-monorepo-plugin
mkdocs-include-markdown-plugin
mkdocs-git-revision-date-localized-plugin
mike
neoteroi-mkdocs

27 changes: 21 additions & 6 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -105,17 +105,35 @@ nav:
- Migration Guides and Deprecations: 10-migration-guides/index.md

plugins:
- include-markdown
- search
- git-revision-date-localized
- neoteroi.mkdocsoad:
use_pymdownx: true

theme:
name: material
logo: "assets/icons/logo_bw.svg"
favicon: "assets/icons/logo_bw.svg"
palette:
- scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.tabs
- navigation.sections
# - navigation.tabs
- navigation.instant
- navigation.tracking
- navigation.top
- search.suggest
- version

extra_css:
- assets/css/theme.css
- assets/css/mkdocsoad-v1.0.2.css

markdown_extensions:
- admonition
Expand All @@ -130,6 +148,3 @@ markdown_extensions:
custom_checkbox: true
- pymdownx.tabbed:
alternate_style: true

extra_css:
- css/mkdocsoad-v1.0.2.css

0 comments on commit f398bf8

Please sign in to comment.