feat: mkdocs alfa version

.github/workflows/docs.yml

@@ -0,0 +1,25 @@
+name: ci
+on:
+  push:
+    branches:
+      - master
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material mkdocstrings-python
+      - run: mkdocs gh-deploy --force

.gitignore

@@ -6,3 +6,4 @@ venv/
 /**/.idea/
 *egg-info*
 .coverage
+site/

docs/animation.md

@@ -0,0 +1 @@
+# DrawZero animations

docs/examples.md

@@ -0,0 +1,13 @@
+# DrawZero examples
+
+
+![00_hello_world](ex_00.png)
+``` title="00_hello_world.py"
+--8<-- "src/drawzero/examples/00_hello_world.py"
+```
+
+
+![01_grid_and_coordinates](ex_01.png)
+``` title="01_grid_and_coordinates.py"
+--8<-- "src/drawzero/examples/01_grid_and_coordinates.py"
+```

docs/gradient.md

@@ -0,0 +1,4 @@
+::: drawzero.utils.gradient
+    options:
+      show_bases: false
+      show_source: true

docs/index.md

@@ -0,0 +1 @@
+# DrawZero

docs/installation.md

@@ -0,0 +1,18 @@
+# Installation
+
+In a Terminal window, type:
+```shell
+pip install drawzero --upgrade --user
+```
+
+
+Or run the following program:
+
+```python
+import os, sys
+python = sys.executable
+user = '--user' if 'venv' not in python and 'virtualenvs' not in python else ''
+cmd = f'"{python}" -m pip install drawzero --upgrade {user}'
+os.system(cmd)
+from drawzero import *
+```

docs/pt.md

@@ -0,0 +1,4 @@
+::: drawzero.utils.pt
+    options:
+      show_bases: false
+      show_source: true

mkdocs.yml

@@ -0,0 +1,50 @@
+site_name: DrawZero — zero boilerplate canvas drawing and animation
+site_url: https://drawzero.ru
+repo_url: https://github.com/ShashkovS/drawzero
+
+nav:
+  - DrawZero: index.md
+  - Installation: installation.md
+  - Examples: examples.md
+  - Animations: animation.md
+  - Code Reference:
+    - Pt: pt.md
+    - Gradient: gradient.md
+
+theme:
+  name: material
+  highlightjs: true
+  language: ru
+  features:
+    - navigation.instant
+    - navigation.instant.prefetch
+    - navigation.tracking
+    - navigation.expand
+    - navigation.path
+    - toc.follow
+    - navigation.top
+    - search.suggest
+    - search.highlight
+
+extra:
+  alternate:
+    - name: English
+      link: /en/
+  homepage: https://drawzero.ru
+
+plugins:
+  - search:
+      lang:
+        - ru
+        - en
+  - mkdocstrings:
+      default_handler: python
+
+markdown_extensions:
+  - pymdownx.snippets
+  - pymdownx.highlight:
+      use_pygments: true
+  - pymdownx.superfences
+
+watch:
+  - src

requirements-dev.txt

@@ -2,3 +2,5 @@ pytest
 coverage
 wheel
 twine
+mkdocs-material
+mkdocstrings-python