Skip to content
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.

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

docs: add copyright + auto palette + dates #1380

Merged
merged 1 commit into from
Jan 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This site serves as extended documentation for bottom alongside the [`README.md`

!!! Tip

It is a good idea to first check out the [Support](support/official.md) page to see if your system is officially supported!
It's as good idea to first check out the [Support](support/official.md) page to see if your system is officially supported!

!!! Tip

Expand Down
20 changes: 16 additions & 4 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,32 +9,42 @@ docs_dir: "content/"
repo_name: ClementTsang/bottom
repo_url: https://github.com/ClementTsang/bottom
edit_uri: "edit/main/docs/content/"
copyright: Copyright © 2019 - 2024 Clement Tsang

# Theming
theme:
name: material
features:
- content.action.edit
- navigation.tabs
- navigation.top
- navigation.expand
- navigation.instant
- navigation.sections
- navigation.footer
- toc.integrate
- search.suggest
- search.highlight
icon:
edit: material/pencil
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
scheme: default
toggle:
icon: material/brightness-auto
name: Switch to light mode
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/weather-night
icon: material/weather-sunny
name: Switch to dark mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/weather-sunny
name: Switch to light mode
icon: material/weather-night
name: Switch to system preference
custom_dir: "content/overrides"
extra_css:
- stylesheets/extra.css
Expand Down Expand Up @@ -115,6 +125,8 @@ plugins:
- search
- mike:
canonical_version: stable
- git-revision-date-localized:
type: date

extra:
# Versioning
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ mkdocs == 1.5.3
mkdocs-material == 9.5.3
mdx_truly_sane_lists == 1.3
mike == 2.0.0

mkdocs-git-revision-date-localized-plugin == 1.2.2
6 changes: 4 additions & 2 deletions docs/serve.sh
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@ if [ ! -d $VENV_PATH ]; then
source ./venv/bin/activate;
pip install --upgrade pip;
pip install -r requirements.txt;
./venv/bin/mike serve;
./venv/bin/mkdocs serve;
else
echo "venv already found.";
source ./venv/bin/activate;
./venv/bin/mike serve;
pip install --upgrade pip;
pip install -r requirements.txt;
./venv/bin/mkdocs serve;
fi;