Skip to content

Commit

Permalink
Paint the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
doshitan committed Jan 13, 2025
1 parent b1142dc commit 81450ef
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -282,3 +282,11 @@ The Makefile has a number of useful commands, see the output of `make help`.

You may want to consider setting up a pre-commit hook for or just manually
running `make check` before pushing work, as this will run useful checks.

# Credits

Icon designed by OpenMoji – the open-source emoji and icon project. License: [CC
BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/#)

Built on the back of [Copier](https://github.com/copier-org/copier).

Binary file added docs/assets/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions docs/assets/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions docs/stylesheets/extra.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.md-header__button.md-logo {
margin-top: 0;
margin-bottom: 0;
padding-top: 0;
padding-bottom: 0;
}

.md-header__button.md-logo img,
.md-header__button.md-logo svg {
height: 2.4rem;
width: 2.4rem;
}
8 changes: 8 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ repo_name: navapbc/platform-cli

theme:
name: material
favicon: assets/favicon.png
logo: assets/logo.svg
features:
- content.code.annotate
- content.code.copy
Expand All @@ -14,24 +16,30 @@ theme:
# https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#automatic-light-dark-mode
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
primary: teal
toggle:
icon: material/brightness-auto
name: Switch to light mode

# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: teal
toggle:
icon: material/brightness-7
name: Switch to dark mode

# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: teal
toggle:
icon: material/brightness-4
name: Switch to system preference

extra_css:
- stylesheets/extra.css

markdown_extensions:
- admonition
- github-callouts
Expand Down

0 comments on commit 81450ef

Please sign in to comment.