diff --git a/.gitignore b/.gitignore
index 7a5dcbc..517cd87 100644
--- a/.gitignore
+++ b/.gitignore
@@ -172,5 +172,6 @@ poetry.toml
.task.mk
# copy of README.md
docs/index.md
+docs/cli.md
docs/viv.py
docs/svgs
diff --git a/Makefile b/Makefile
index c8d8a0d..aca9ac7 100644
--- a/Makefile
+++ b/Makefile
@@ -35,7 +35,8 @@ docs/viv.py: src/viv/viv.py
cp $< $@
docs/index.md: README.md
- cp $< $@
+ printf -- '---\nhide: [navigation]\n---\n\n' > $@
+ cat $< >> $@
examples/black: .FORCE
rm -f $@
diff --git a/README.md b/README.md
index 4b68e08..183524d 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,13 @@
+
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
+[![PYPI][pypi-shield]][pypi-url]
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://pre-commit.com)
+
+
@@ -123,3 +133,14 @@ python3 <(curl -fsSL viv.dayl.in/viv.py) shim black -o ./black --standalone --fr
[^1]: You do need to have `pip` but surely you have `pip` already.
+
+
+
+[pypi-shield]: https://img.shields.io/pypi/v/viv
+[pypi-url]: https://pypi.org/project/viv
+[stars-shield]: https://img.shields.io/github/stars/daylinmorgan/viv.svg
+[stars-url]: https://github.com/daylinmorgan/viv/stargazers
+[issues-shield]: https://img.shields.io/github/issues/daylinmorgan/viv.svg
+[issues-url]: https://github.com/daylinmorgan/viv/issues
+[license-shield]: https://img.shields.io/github/license/daylinmorgan/viv.svg
+[license-url]: https://github.com/daylinmorgan/viv/blob/main/LICENSE
diff --git a/docs/cli.md b/docs/cli.md
deleted file mode 100644
index 8599a00..0000000
--- a/docs/cli.md
+++ /dev/null
@@ -1,43 +0,0 @@
-
-# cli
-
-![help](./svgs/viv-help.svg)
-
-## list
-![cmd](./svgs/viv-list-help.svg)
-
-## exe
-![cmd](./svgs/viv-exe-help.svg)
-
-## manage
-![cmd](./svgs/viv-manage-help.svg)
-
-### manage update
-![cmd](./svgs/viv-manage-update-help.svg)
-
-### manage purge
-![cmd](./svgs/viv-manage-purge-help.svg)
-
-### manage show
-![cmd](./svgs/viv-manage-show-help.svg)
-
-### manage install
-![cmd](./svgs/viv-manage-install-help.svg)
-
-## freeze
-![cmd](./svgs/viv-freeze-help.svg)
-
-## shim
-![cmd](./svgs/viv-shim-help.svg)
-
-## run
-![cmd](./svgs/viv-run-help.svg)
-
-## cache
-![cmd](./svgs/viv-cache-help.svg)
-
-### cache info
-![cmd](./svgs/viv-cache-info-help.svg)
-
-### cache remove
-![cmd](./svgs/viv-cache-remove-help.svg)
diff --git a/mkdocs.yml b/mkdocs.yml
index b232073..b43a4e9 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -4,12 +4,18 @@ repo_url: https://github.com/daylinmorgan/viv
edit_uri: edit/main/docs/
repo_name: daylinmorgan/viv
+nav:
+ - home: index.md
+ - cli: cli.md
+
theme:
name: material
logo: https://raw.githubusercontent.com/daylinmorgan/viv/main/assets/logo.svg
favicon: https://raw.githubusercontent.com/daylinmorgan/viv/main/assets/logo.svg
features:
+ - navigation.tabs
- navigation.indexes
+
palette:
# Palette toggle for dark mode
- scheme: slate
@@ -27,4 +33,3 @@ theme:
markdown_extensions:
- footnotes
-
diff --git a/scripts/generate-svgs.py b/scripts/generate-svgs.py
index 43c2aaf..e10192c 100755
--- a/scripts/generate-svgs.py
+++ b/scripts/generate-svgs.py
@@ -28,7 +28,11 @@ CLI_DOC_PATH = DOCS_PATH / "cli.md"
)
-cli_doc = """
+cli_doc = """\
+---
+hide: [navigation]
+---
+
# cli
![help](./svgs/viv-help.svg)