diff options
| author | Clement Tsang <34804052+ClementTsang@users.noreply.github.com> | 2024-01-11 03:20:35 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-01-11 03:20:35 -0500 |
| commit | 16a94d65d29c150c8ecfd40b64b9282eaea51714 (patch) | |
| tree | 8620e156c24368fef458c61f1f46c312e543ec53 /docs | |
| parent | b106121a846c4493ff24076b7736934475550ee1 (diff) | |
add last revision date (#1380)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/content/index.md | 2 | ||||
| -rw-r--r-- | docs/mkdocs.yml | 20 | ||||
| -rw-r--r-- | docs/requirements.txt | 2 | ||||
| -rwxr-xr-x | docs/serve.sh | 6 |
4 files changed, 22 insertions, 8 deletions
diff --git a/docs/content/index.md b/docs/content/index.md index 39969b9a..d40bd5a5 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -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 diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index c0b3fb58..e8a49340 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -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 @@ -115,6 +125,8 @@ plugins: - search - mike: canonical_version: stable + - git-revision-date-localized: + type: date extra: # Versioning diff --git a/docs/requirements.txt b/docs/requirements.txt index 8e9152d1..0c9bcadf 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -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 diff --git a/docs/serve.sh b/docs/serve.sh index 126cace9..c19c451c 100755 --- a/docs/serve.sh +++ b/docs/serve.sh @@ -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; |