docs: add badges

This commit is contained in:
Daylin Morgan 2023-08-21 15:16:18 -05:00
parent 0e12692b71
commit 10e668b2d9
Signed by: daylin
GPG key ID: C1E52E7DD81DF79F
6 changed files with 35 additions and 46 deletions

1
.gitignore vendored
View file

@ -172,5 +172,6 @@ poetry.toml
.task.mk .task.mk
# copy of README.md # copy of README.md
docs/index.md docs/index.md
docs/cli.md
docs/viv.py docs/viv.py
docs/svgs docs/svgs

View file

@ -35,7 +35,8 @@ docs/viv.py: src/viv/viv.py
cp $< $@ cp $< $@
docs/index.md: README.md docs/index.md: README.md
cp $< $@ printf -- '---\nhide: [navigation]\n---\n\n' > $@
cat $< >> $@
examples/black: .FORCE examples/black: .FORCE
rm -f $@ rm -f $@

View file

@ -1,3 +1,13 @@
<!-- badges -->
[![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)
<!--[![Conda][conda-shield]][conda-url]-->
<div align="center"> <div align="center">
<a href="https://github.com/daylinmorgan/viv"> <a href="https://github.com/daylinmorgan/viv">
<img src="https://raw.githubusercontent.com/daylinmorgan/viv/main/assets/logo.svg" alt="Logo" width=500 > <img src="https://raw.githubusercontent.com/daylinmorgan/viv/main/assets/logo.svg" alt="Logo" width=500 >
@ -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. [^1]: You do need to have `pip` but surely you have `pip` already.
<!-- [conda-shield]: https://img.shields.io/conda/vn/conda-forge/viv-->
<!-- [conda-url]: https://anaconda.org/conda-forge/viv -->
[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

View file

@ -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)

View file

@ -4,12 +4,18 @@ repo_url: https://github.com/daylinmorgan/viv
edit_uri: edit/main/docs/ edit_uri: edit/main/docs/
repo_name: daylinmorgan/viv repo_name: daylinmorgan/viv
nav:
- home: index.md
- cli: cli.md
theme: theme:
name: material name: material
logo: https://raw.githubusercontent.com/daylinmorgan/viv/main/assets/logo.svg logo: https://raw.githubusercontent.com/daylinmorgan/viv/main/assets/logo.svg
favicon: https://raw.githubusercontent.com/daylinmorgan/viv/main/assets/logo.svg favicon: https://raw.githubusercontent.com/daylinmorgan/viv/main/assets/logo.svg
features: features:
- navigation.tabs
- navigation.indexes - navigation.indexes
palette: palette:
# Palette toggle for dark mode # Palette toggle for dark mode
- scheme: slate - scheme: slate
@ -27,4 +33,3 @@ theme:
markdown_extensions: markdown_extensions:
- footnotes - footnotes

View file

@ -28,7 +28,11 @@ CLI_DOC_PATH = DOCS_PATH / "cli.md"
) )
cli_doc = """ cli_doc = """\
---
hide: [navigation]
---
# cli # cli
![help](./svgs/viv-help.svg) ![help](./svgs/viv-help.svg)