Add mkdocs

.github/workflows/ci.yaml

@@ -0,0 +1,23 @@
+---
+name: ci
+on:  # yamllint disable-line rule:truthy
+  push:
+    paths:
+      - 'docs/**'
+      - 'mkdocs.**'
+    branches:
+      - main
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout main
+        uses: actions/checkout@v2.4.0
+
+      - name: Deploy docs
+        uses: mhausenblas/mkdocs-deploy-gh-pages@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CONFIG_FILE: mkdocs.yml

docs/index.md

@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.

mkdocs.yml

@@ -0,0 +1,97 @@
+---
+site_name: Solar Battery Charger
+site_description: A solar battery charger to charge lithium ion (li-ion) 18650, 9V, and coin batteries and Ni-MH AA and AAA batteries.
+site_author: Nicholas Wilde
+site_url: https://nicholaswilde.io/solar-battery-charger
+copyright: Copyright © 2022 Nicholas Wilde
+dev_addr: '0.0.0.0:8000'
+
+# Repository
+repo_name: nicholaswilde/solar-battery-charger
+repo_url: https://github.com/nicholaswilde/solar-battery-charger
+edit_uri: ""
+
+# Page tree
+nav:
+  - Home: index.md
+
+extra:
+  social:
+    - icon: fontawesome/solid/home
+      link: https://nicholaswilde.io/
+    - icon: fontawesome/brands/github
+      link: https://github.com/nicholaswilde
+    - icon: fontawesome/brands/twitter
+      link: https://twitter.com/nicholascwilde
+    - icon: fontawesome/brands/instagram
+      link: https://www.instagram.com/wildewoodworking/
+    - icon: fontawesome/brands/linkedin-in
+      link: https://www.linkedin.com/in/nicholaswilde
+    - icon: fontawesome/brands/facebook
+      link: https://www.facebook.com/nicholas.wilde/
+    - icon: fontawesome/solid/key
+      link: https://github.com/nicholaswilde.gpg
+
+theme:
+  name: material
+  language: en
+  features:
+    - navigation.top
+  palette:
+    - scheme: default
+      primary: indigo
+      accent: blue
+      toggle:
+        icon: material/toggle-switch-off-outline
+        name: Switch to dark mode
+    - scheme: slate
+      primary: blue
+      accent: indigo
+      toggle:
+        icon: material/toggle-switch
+        name: Switch to light mode
+
+plugins:
+  - search
+  - minify:
+      minify_html: true
+
+# Extensions
+markdown_extensions:
+  - admonition
+  - abbr
+  - attr_list
+  - def_list
+  - footnotes
+  - meta
+  - md_in_html
+  - toc:
+      permalink: true
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.critic
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.highlight
+  - pymdownx.inlinehilite
+  - pymdownx.keys
+  - pymdownx.magiclink:
+      repo_url_shorthand: true
+      user: nicholaswilde
+      repo: notes
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid-experimental
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.tabbed
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde