add mkdocs build

Author: Massimiliano Pippi

.github/workflows/docs.yaml

@@ -0,0 +1,58 @@
+name: docs
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    paths:
+      - 'docs/**'
+      - 'docsgen/**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install Taskfile
+        uses: Arduino/actions/setup-taskfile@master
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Setup Go
+        uses: actions/setup-go@v1
+
+      - name: Setup Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: '3.6'
+          architecture: 'x64'
+
+      - name: Cache dependencies
+        uses: actions/cache@v1
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+          python3 -m pip install -r ./requirements_docs.txt
+
+      - name: Generate command reference
+        working-directory: docsgen
+        run: task gen:commands
+
+      - name: Build docs website
+        run: mkdocs build -s
+
+      # - name: Deploy
+      #   uses: peaceiris/actions-gh-pages@v3
+      #   with:
+      #     github_token: ${{ secrets.GITHUB_TOKEN }}
+      #     publish_dir: ./docs

mkdocs.yml

@@ -0,0 +1,96 @@
+# Project information
+site_name: Arduino CLI
+site_description: Arduino Command Line Interface
+site_url: https://arduino.github.io/arduino-cli/
+
+# Repository
+repo_name: arduino/arduino-cli
+repo_url: https://github.com/arduino/arduino-cli
+edit_uri: ""
+
+# Copyright
+copyright: 'Copyright 2020 ARDUINO SA (http://www.arduino.cc/)'
+
+# Configuration
+site_dir: public
+edit_uri: ""
+
+# Theme
+theme:
+  name: material
+  palette:
+    primary: teal
+    accent: orange
+
+# Extensions
+markdown_extensions:
+  - markdown.extensions.admonition
+  - markdown.extensions.codehilite:
+      guess_lang: false
+  - markdown.extensions.def_list
+  - markdown.extensions.footnotes
+  - markdown.extensions.meta
+  - markdown.extensions.toc:
+      permalink: true
+  - pymdownx.arithmatex
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.critic
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_index: !!python/name:pymdownx.emoji.twemoji
+      emoji_generator: !!python/name:pymdownx.emoji.to_svg
+  - pymdownx.inlinehilite
+  - pymdownx.keys
+  - pymdownx.magiclink:
+      repo_url_shorthand: true
+      user: squidfunk
+      repo: mkdocs-material
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.superfences
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+
+# Navigation
+nav:
+  - Documentation Home: 'index.md'
+  - getting-started.md
+  - Command reference:
+    - commands/arduino-cli.md
+    - board: commands/arduino-cli_board.md
+    - board attach: commands/arduino-cli_board_attach.md
+    - board details: commands/arduino-cli_board_details.md
+    - board list: commands/arduino-cli_board_list.md
+    - board listall: commands/arduino-cli_board_listall.md
+    - cache: commands/arduino-cli_cache.md
+    - cache clean: commands/arduino-cli_cache_clean.md
+    - compile: commands/arduino-cli_compile.md
+    - config: commands/arduino-cli_config.md
+    - config dump: commands/arduino-cli_config_dump.md
+    - config init: commands/arduino-cli_config_init.md
+    - core: commands/arduino-cli_core.md
+    - core download: commands/arduino-cli_core_download.md
+    - core install: commands/arduino-cli_core_install.md
+    - core list: commands/arduino-cli_core_list.md
+    - core search: commands/arduino-cli_core_search.md
+    - core uninstall: commands/arduino-cli_core_uninstall.md
+    - core update index: commands/arduino-cli_core_update-index.md
+    - core upgrade: commands/arduino-cli_core_upgrade.md
+    - daemon: commands/arduino-cli_daemon.md
+    - debug: commands/arduino-cli_debug.md
+    - lib: commands/arduino-cli_lib.md
+    - lib deps: commands/arduino-cli_lib_deps.md
+    - lib download: commands/arduino-cli_lib_download.md
+    - lib install: commands/arduino-cli_lib_install.md
+    - lib list: commands/arduino-cli_lib_list.md
+    - lib search: commands/arduino-cli_lib_search.md
+    - lib uninstall: commands/arduino-cli_lib_uninstall.md
+    - lib update-index: commands/arduino-cli_lib_update-index.md
+    - lib upgrade: commands/arduino-cli_lib_upgrade.md
+    - sketch: commands/arduino-cli_sketch.md
+    - sketch new: commands/arduino-cli_sketch_new.md
+    - upload: commands/arduino-cli_upload.md
+    - version: commands/arduino-cli_version.md

requirements_docs.txt

@@ -0,0 +1,2 @@
+mkdocs
+mkdocs-material