chore: update deps, readme, docs

- disables `package.yaml` workflow release trigger

Author: yozachar

.github/workflows/package.yaml

@@ -2,8 +2,9 @@
 name: package
 on:
   workflow_dispatch:
-  release:
-    types: [published]
+  # uncomment the following lines to enable workflow on package release
+  # release:
+  #   types: [published]
 jobs:
   build:
     runs-on: ubuntu-latest

README.md

@@ -1,6 +1,8 @@
 # validators - Python Data Validation for Humans™
 
-[![PyCQA][pycqa-badge]][pycqa-link] [![SAST][sast-badge]][sast-link] [![Package][package-badge]][package-link] [![Docs][docs-badge]][docs-link] [![Version][vs-badge]][vs-link] [![Downloads][dw-badge]][dw-link]
+[![PyCQA][pycqa-badge]][pycqa-link] [![SAST][sast-badge]][sast-link] [![Docs][docs-badge]][docs-link] [![Version][vs-badge]][vs-link] [![Downloads][dw-badge]][dw-link]
+
+<!-- [![Package][package-badge]][package-link] -->
 
 Python has all kinds of data validation tools, but every one of them seems to
 require defining a schema or form. I wanted to create a simple validation
@@ -9,7 +11,7 @@ schema.
 
 ```python
 >>> import validators
-
+>>> 
 >>> validators.email('someone@example.com')
 True
 ```
@@ -26,11 +28,12 @@ True
 [sast-link]: https://github.com/python-validators/validators/actions/workflows/sast.yaml
 [pycqa-badge]: https://github.com/python-validators/validators/actions/workflows/pycqa.yaml/badge.svg
 [pycqa-link]: https://github.com/python-validators/validators/actions/workflows/pycqa.yaml
-[package-badge]: https://github.com/python-validators/validators/actions/workflows/package.yaml/badge.svg
-[package-link]: https://github.com/python-validators/validators/actions/workflows/package.yaml
 [docs-badge]: https://github.com/python-validators/validators/actions/workflows/docs.yaml/badge.svg
 [docs-link]: https://github.com/python-validators/validators/actions/workflows/docs.yaml
-[vs-badge]: https://img.shields.io/pypi/v/validators.svg
+[vs-badge]: https://img.shields.io/pypi/v/validators?logo=pypi&logoColor=white&label=version&color=blue
 [vs-link]: https://pypi.python.org/pypi/validators/
-[dw-badge]: https://img.shields.io/pypi/dm/validators.svg
+[dw-badge]: https://img.shields.io/pypi/dm/validators?logo=pypi&logoColor=white&color=blue
 [dw-link]: https://pypi.python.org/pypi/validators/
+
+<!-- [package-badge]: https://github.com/python-validators/validators/actions/workflows/package.yaml/badge.svg
+[package-link]: https://github.com/python-validators/validators/actions/workflows/package.yaml -->

docs/index.md

@@ -1,6 +1,8 @@
 # validators - Python Data Validation for Humans™
 
-[![PyCQA][pycqa-badge]][pycqa-link] [![SAST][sast-badge]][sast-link] [![Package][package-badge]][package-link] [![Docs][docs-badge]][docs-link] [![Version][vs-badge]][vs-link] [![Downloads][dw-badge]][dw-link]
+[![PyCQA][pycqa-badge]][pycqa-link] [![SAST][sast-badge]][sast-link] [![Docs][docs-badge]][docs-link] [![Version][vs-badge]][vs-link] [![Downloads][dw-badge]][dw-link]
+
+<!-- [![Package][package-badge]][package-link] -->
 
 Python has all kinds of data validation tools, but every one of them seems to
 require defining a schema or form. I wanted to create a simple validation
@@ -9,7 +11,7 @@ schema.
 
 ```python
 >>> import validators
-
+>>> 
 >>> validators.email('someone@example.com')
 True
 ```
@@ -26,11 +28,12 @@ True
 [sast-link]: https://github.com/python-validators/validators/actions/workflows/sast.yaml
 [pycqa-badge]: https://github.com/python-validators/validators/actions/workflows/pycqa.yaml/badge.svg
 [pycqa-link]: https://github.com/python-validators/validators/actions/workflows/pycqa.yaml
-[package-badge]: https://github.com/python-validators/validators/actions/workflows/package.yaml/badge.svg
-[package-link]: https://github.com/python-validators/validators/actions/workflows/package.yaml
 [docs-badge]: https://github.com/python-validators/validators/actions/workflows/docs.yaml/badge.svg
 [docs-link]: https://github.com/python-validators/validators/actions/workflows/docs.yaml
-[vs-badge]: https://img.shields.io/pypi/v/validators.svg
+[vs-badge]: https://img.shields.io/pypi/v/validators?logo=pypi&logoColor=white&label=version&color=blue
 [vs-link]: https://pypi.python.org/pypi/validators/
-[dw-badge]: https://img.shields.io/pypi/dm/validators.svg
+[dw-badge]: https://img.shields.io/pypi/dm/validators?logo=pypi&logoColor=white&color=blue
 [dw-link]: https://pypi.python.org/pypi/validators/
+
+<!-- [package-badge]: https://github.com/python-validators/validators/actions/workflows/package.yaml/badge.svg
+[package-link]: https://github.com/python-validators/validators/actions/workflows/package.yaml -->

mkdocs.yaml

@@ -2,16 +2,18 @@ site_name: "validators"
 site_description: "Automatic documentation from sources, for MkDocs."
 site_url: "https://python-validators.github.io/validators/"
 repo_url: "https://github.com/python-validators/validators"
-edit_uri: "tree/master/docs/"
+edit_uri: "edit/master/docs/"
 repo_name: "validators/validators"
 site_dir: "site"
 watch: [README.md, src/validators/]
 
-nav:
-  - Home: index.md
-
 theme:
   name: material
+  icon:
+    logo: material/marker-check
+  font:
+    text: Inter
+    code: "Fira Code"
   palette:
     - media: "(prefers-color-scheme: light)"
       scheme: default
@@ -28,6 +30,14 @@ theme:
         icon: material/toggle-switch-off-outline
         name: Switch to light mode
 
+markdown_extensions:
+  - toc:
+      permalink: true
+  - pymdownx.superfences
+  - pymdownx.highlight:
+      use_pygments: true
+  - pymdownx.inlinehilite
+
 plugins:
   - search
   - mkdocstrings:
@@ -37,8 +47,16 @@ plugins:
             show_root_heading: true
           import:
             - https://docs.python-requests.org/en/master/objects.inv
+  - git-revision-date-localized
 
 extra:
   social:
     - icon: fontawesome/brands/github
-      link: https://github.com/python-validators/validators
+      link: https://github.com/python-validators
+    - icon: fontawesome/brands/python
+      link: https://pypi.org/project/validators
+
+copyright: Copyright © 2013 - 2023 Konsta Vesterinen
+
+nav:
+  - Home: index.md