chore: Add Robůtek documentation and assets

.github/workflows/deploy-ghpages.yml

@@ -0,0 +1,27 @@
+name: Deploy to GitHub Pages
+on:
+  push:
+    branches:
+      - master
+      - main
+  # schedule:
+  #   - cron: '0 0 1 * *' # every month
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - 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 -r requirements.txt
+      - run: mkdocs gh-deploy --force

.gitignore

@@ -35,3 +35,7 @@ hw/~_autosave-Zelvicka.kicad_pcb.lck
 hw/jlcdata/gerber
 hw/jlcdata/gerbers.zip
 hw/Zelvicka.step
+
+.DS_Store
+.venv/
+site/

README.md

@@ -5,7 +5,7 @@
 ![gif](https://roboticsbrno.github.io/Robutek/rotating.gif)
 
 
-## elektro
+<!-- ## elektro
 * 1x 18650 ve slotu
 * nabíjení z USB-C z 5V - avšak je potřeba rozpoznávat proudové schopnosti portu 0,5/1,5/víc?
 * stepup na předběžně 6V pro motory a serva
@@ -63,4 +63,4 @@
     * MAX77757
     * LD39200
     * DRV8833
-    * ITR8307/S17/TR8(B)
+    * ITR8307/S17/TR8(B) -->

docs/CNAME

@@ -0,0 +1 @@
+robutek.robotikabrno.cz

docs/assets/style.css

@@ -0,0 +1,57 @@
+body > header > nav > a {
+	background-color: white;
+	border-radius: 20px;
+}
+
+body > div.md-container > main > div > div.md-sidebar.md-sidebar--primary > div > div > nav > label > a > img {
+	background-color: white;
+	border-radius: 50px;
+}
+
+
+nav img:hover {
+	animation-name: spin;
+	animation-duration: 500ms;
+	animation-iteration-count: infinite;
+	animation-timing-function: linear;
+}
+
+
+/* #fancy-image { */
+.fancy-image:hover {
+	animation-name: spin;
+	animation-duration: 2000ms;
+	animation-iteration-count: infinite;
+	animation-timing-function: linear;
+}
+
+@keyframes spin {
+    from {
+        transform:rotate(0deg);
+    }
+    to {
+        transform:rotate(360deg);
+    }
+}
+
+
+#indexHead {
+	text-align: center;
+}
+
+.container {
+	display: flex;
+	flex-wrap: wrap;
+	flex-flow: row wrap;
+	align-items: flex-end;
+	justify-content: space-around;
+}
+
+.col--1 {
+	flex: 1;
+}
+
+[data-md-color-scheme="default"] img {
+	-webkit-filter: drop-shadow(0px 0px 2px #222222);
+	filter: drop-shadow(0px 0px 2px #222222);
+}

docs/index.md

@@ -0,0 +1,3 @@
+# Robůtek
+
+Tady bude hezký popis Robůtka.

mkdocs.yml

@@ -0,0 +1,133 @@
+docs_dir: docs
+site_name: Robůtek
+site_url: https://robutuek.robotikabrno.cz
+site_description: >-
+  Návod na programování Robůtek
+
+repo_name: RoboticsBrno/Robutek
+repo_url: https://github.com/RoboticsBrno/Robutek
+
+# Copyright
+# copyright: Copyright © RoboticsBrno
+use_directory_urls: True
+
+theme:
+  name: material
+  language: cs
+  logo: assets/logo.svg
+  favicon: assets/logo.svg
+  features:
+    - navigation.tabs
+    - navigation.indexes
+    - navigation.top
+    - content.code.copy
+    - content.code.annotate
+  custom_dir: overrides
+
+  icon:
+    repo: fontawesome/brands/github
+
+  palette:
+    - scheme: slate
+      primary: lime
+      accent: lime
+      toggle:
+        icon: material/weather-sunny
+        name: Přepnout na světý režim
+    - scheme: default
+      primary: lime
+      accent: lime
+      toggle:
+        icon: material/weather-night
+        name: Přepnout na tmavý režim
+
+markdown_extensions:
+  - pymdownx.highlight
+  - pymdownx.inlinehilite
+  - pymdownx.superfences
+  - pymdownx.keys
+  - admonition
+  - pymdownx.details
+  - pymdownx.keys
+  - attr_list
+  - pymdownx.tabbed
+  - meta
+  - pymdownx.snippets:
+      url_download: True
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - toc:
+      permalink: "¤"
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+
+plugins:
+  - search
+  - open-in-new-tab
+  - glightbox:
+      auto_caption: true
+  - resize-images:
+      source-dir: assets-large
+      target-dir: assets
+      enable_cache: True
+      size: [1000, 800]
+      extensions: [".jpg", ".jpeg", ".png", ".gif"]
+  # - typedoc:
+  #     source: "./docs/elks/lekce1/example1/@types/*.d.ts"
+  #     output_dir: "jaculusApi"
+  #     tsconfig: "./docs/elks/lekce1/example1/tsconfig.json"
+  #     options: "typedoc.json"
+  #     name: "Jaculus API documentation"
+
+  # - zip_folders:
+  #     folders:
+  #       - robot/lekce1/example1
+  #       - robot/lekce3/project3
+  #       - robot/lekce4/project4
+  #       - robot/lekce6/project6
+  #       - robot/lekce8/project8
+  #     debug: true
+
+  - auto-refresh-build-pages:
+      update_message: "Návod byl aktualizován, chcete načíst novou verzi?"
+      yes_button_text: "Ano"
+      no_button_text: "Ne"
+
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/RoboticsBrno
+    - icon: fontawesome/brands/twitter
+      link: https://twitter.com/RobotikaBrno
+    - icon: fontawesome/brands/facebook
+      link: https://www.facebook.com/robotarna.helceletka
+    - icon: fontawesome/brands/youtube
+      link: https://www.youtube.com/@robotikabrno-robotarnaasps2392
+    - icon: fontawesome/brands/instagram
+      link: https://www.instagram.com/robotarna.helceletka
+#   analytics:
+#     provider: google
+#     property: ASD
+
+extra_css:
+  - assets/style.css
+
+nav:
+  - Domů:
+      - index.md
+  # - Programování robota:
+  #     - robot/index.md
+  #     - robot/faq/index.md
+  #     - robot/lekce1/index.md
+  #     - robot/lekce2/index.md
+  #     - robot/lekce3/index.md
+  #     - robot/lekce4/index.md
+  #     - robot/lekce5/index.md
+  #     - robot/lekce6/index.md
+  #     - robot/lekce7/index.md
+  #     - robot/lekce8/index.md
+  #     - robot/lekce9/index.md
+  #     - robot/lekce10/index.md
+  # - Složení robota:
+  #     - robotAssembly/index.md

overrides/404.html

@@ -0,0 +1,9 @@
+{% extends "main.html" %}
+
+<!-- Content -->
+{% block content %}
+  <div align="center">
+    <h1 >Ejhle, tady nic není...</h1>
+    <img class="fancy-image" src="/assets/logo.svg">
+  </div>
+{% endblock %}

requirements.txt

@@ -0,0 +1,9 @@
+mkdocs==1.6.0
+mkdocs-material==9.5.24
+mkdocs-macros-plugin==1.0.5
+mkdocs-open-in-new-tab==1.0.3
+mkdocs-glightbox==0.4.0
+mkdocs-typedoc==1.0.4
+mkdocs-resize-images==1.0.1
+mkdocs-zip-folders==1.0.3
+mkdocs-auto-refresh-build-pages==1.0.2