Add mkdocs

.github/workflows/gh-pages.yaml

@@ -0,0 +1,32 @@
+name: GitHub Pages
+on:
+  push:
+    branches:
+      - mkdocs
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - name: Install MkDocs dependencies
+        run: pip install mkdocs-material
+      - name: Deploy MkDocs
+        working-directory: ./documentation
+        run: mkdocs gh-deploy --force

documentation/.pages

@@ -0,0 +1,5 @@
+nav:
+    - index.md
+    - setup/index.md
+    - support.md
+    - aaaaa.md

documentation/docs/CNAME

@@ -0,0 +1 @@
+docs.pokypow.com

documentation/docs/index.md

@@ -0,0 +1,124 @@
+# Home
+
+This is the documentation for the PokyPow project.
+
+Designed for Home Assistant.
+
+
+[Buy/Subscribe](https://www.crowdsupply.com/ajfriesen/pokypow){ .md-button .md-button--primary }
+[Getting Started](/setup){ .md-button }
+
+Support me on [Crowd Supply](https://www.crowdsupply.com/ajfriesen/pokypow)!
+
+
+<a href="https://www.crowdsupply.com/ajfriesen/pokypow"><img src="./img/pokypow-pcb-scale-02.jpeg" alt="PokyPow on Crowd Supply"></a>
+<a href="https://www.crowdsupply.com/ajfriesen/pokypow"><img src="./img/crowd-supply-logo-dark.png" alt="I sell on Crowd Supply"></a>
+
+---
+
+## Features { #features }
+
+<div class="grid cards" markdown>
+
+-   :material-power:{ .lg .middle } __Power On/Off__
+
+    ---
+
+    Power on/off your PC with a single click.
+
+    <!-- [:octicons-arrow-right-24: Getting started](getting-started.md) -->
+
+-   :material-restart:{ .lg .middle } __Reboot/Reset__
+
+    ---
+
+    Clean reboot/reset your PC.
+
+    <!-- [:octicons-arrow-right-24: Browser support](browser-support.md) -->
+
+-   :material-radar:{ .lg .middle } __Monitor the Power ON state__
+
+    ---
+
+    See if and how long your PC has been powered on.
+    Use this for automations to power off your PC after a certain amount of time.
+    Parental control for your gaming kids :wink:
+
+    <!-- [:octicons-arrow-right-24: Browser support](browser-support.md) -->
+
+-   :material-cloud-off-outline:{ .lg .middle } __No Cloud__
+
+    ---
+
+    No need for a cloud service. Everything is done locally on your network.
+
+    <!-- [:octicons-arrow-right-24: Performance](performance.md) -->
+
+-   :material-cellphone:{ .lg .middle } __No App__
+
+    ---
+
+    No need to install another *smart* app.
+
+    <!-- [:octicons-arrow-right-24: Search](search.md) -->
+
+-   :material-baseball-bat:{ .lg .middle } __Hard Reset__
+
+    ---
+
+    Your PC has locked up? Do not worry, just hard reset it.
+
+    <!-- [:octicons-arrow-right-24: Search](search.md) -->
+
+-   :material-cat:{ .lg .middle } /:material-baby:{ .lg .middle } __Child Lock/Cat Safe__
+
+    ---
+
+    Deactivate the power button to prevent your PC from being powered on/off from pets, kids, or other people.
+
+    <!-- [:octicons-arrow-right-24: Search](search.md) -->
+
+-   :material-home-assistant:{ .lg .middle } __Integrates with Home Assistant__
+
+    ---
+
+    Integrates with Home Assistant to allow for easy control of your PC.
+    Create automations to power on/off your PC at specific time or when you leave the house.
+    The power is yours.
+
+    <!-- [:octicons-arrow-right-24: Search](search.md) -->
+
+-   :material-api:{ .lg .middle } __API__
+
+    ---
+
+    Provides a API to allow for easy integration with other services.
+
+    <!-- [:octicons-arrow-right-24: Search](search.md) -->
+
+-   :simple-esphome:{ .lg .middle } __ESPHome__
+
+    ---
+
+    Proudly made with ESPHome.
+
+</div>
+
+
+
+---
+
+## Where to buy?
+
+You can join the wait list for the PokyPow [Crowd Supply](https://www.crowdsupply.com/ajfriesen/pokypow/)
+
+
+
+<a href="https://www.crowdsupply.com/ajfriesen/pokypow"><img src="./img/crowd-supply-logo-dark.png" alt="I sell on Crowd Supply"></a>
+
+---
+
+## License
+
+- Software: TBD
+- Hardware: TBD

documentation/docs/setup/index.md

@@ -0,0 +1,14 @@
+# Getting Started
+
+Setup your PokyPow in a few simple steps:
+
+1. Connect the USB-C cable to your PC and the PokyPow.
+2. Flash the firmware to the PokyPow.
+3. Connect the Power, Reset and Power LED on the mainboard and PC case to the PokyPow.
+4. Plug it in a USB2.0 header or use the USB-C port.
+5. Enable "Always On USB" in the BIOS/UEFI.
+6. Adapt the PokyPow in Home Assistant.
+
+
+## Technical Specification
+

documentation/docs/setup/setup.md

@@ -0,0 +1,5 @@
+# Flash Firmware
+
+If you want to build and flash the firmware yourself, you can follow these steps:
+
+TODO:

documentation/docs/stylesheets/extra.css

@@ -0,0 +1,24 @@
+.grid {
+    display: grid;
+    grid-template-columns: repeat(auto-fit, minmax(16rem, 1fr));
+    grid-gap: 1rem;
+    margin: 1rem 0;
+}
+
+.grid.cards > :is(ul, ol) {
+    display: contents;
+}
+
+.grid.cards > :is(ul, ol) > li,
+.grid > .card {
+    border: .05rem solid var(--md-default-fg-color--lightest);
+    border-radius: .5rem;
+    padding: 1rem;
+    transition: border .25s,box-shadow .25s;
+}
+
+.grid.cards > :is(ul, ol) > li:hover,
+.grid > .card:hover {
+    border-color: var(--md-accent-fg-color);
+    box-shadow: var(--md-shadow-z2);
+} 

documentation/docs/support.md

@@ -0,0 +1,4 @@
+
+# Support
+
+## FAQ

documentation/mkdocs.yml

@@ -0,0 +1,67 @@
+site_name: PokyPow
+site_url: https://pokypow.com
+repo_url: https://github.com/ajfriesen/pokypow
+repo_name: ajfriesen/pokypow
+
+site_author: Andrej Friesen
+site_description: >-
+  PokyPow is a USB-C powered switch that allows you to switch between your PC and your console.
+  It is designed to be used with a USB-C cable and a USB-C power supply.
+
+plugins:
+  - search
+  - awesome-pages
+
+theme:
+  name: material
+  features:
+    - navigation.tabs
+    - navigation.sections
+    - navigation.expand
+    - navigation.top
+    - search.suggest
+    - search.highlight
+
+
+# Color scheme
+  palette:
+    - scheme: default
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - scheme: slate
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
+# Extra customization
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/ajfriesen
+    - icon: fontawesome/brands/twitter
+      link: https://twitter.com/mr_ajfriesen
+
+
+
+# Extensions for enhanced markdown
+markdown_extensions:
+  - attr_list
+  - md_in_html
+  - pymdownx.blocks.caption
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+
+extra_javascript:
+  - https://unpkg.com/esp-web-tools@10/dist/web/install-button.js?module
+
+extra_css:
+  - stylesheets/extra.css