docs: gh-pages deployment

.github/workflows/docs-check.yml

@@ -0,0 +1,26 @@
+name: Documentation build
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+    paths:
+      - docs/**
+      - mkdocs.yml
+      - requirements-docs.txt
+      - .github/workflows/docs-check.yml
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - run: python -m pip install -r requirements-docs.txt
+      - run: mkdocs build --strict

.github/workflows/publish-docs.yml

@@ -0,0 +1,69 @@
+name: Publish versioned core documentation
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - "[0-9]*"
+    paths:
+      - docs/**
+      - mkdocs.yml
+      - requirements-docs.txt
+      - .github/workflows/publish-docs.yml
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: publish-root-docs
+  cancel-in-progress: false
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - run: python -m pip install -r requirements-docs.txt
+      - uses: actions/create-github-app-token@v1
+        id: pages-token
+        with:
+          app-id: ${{ secrets.DOCS_PUBLISH_APP_ID }}
+          private-key: ${{ secrets.DOCS_PUBLISH_APP_PRIVATE_KEY }}
+          owner: stm32duino
+          repositories: stm32duino.github.io
+          permission-contents: write
+      - name: Configure Pages remote
+        env:
+          PAGES_TOKEN: ${{ steps.pages-token.outputs.token }}
+        run: git remote add pages "https://x-access-token:${PAGES_TOKEN}@github.com/stm32duino/stm32duino.github.io.git"
+      - name: Publish development documentation
+        if: github.ref == 'refs/heads/main'
+        run: |
+          if git ls-remote --exit-code --heads pages gh-pages >/dev/null; then
+            mike deploy --remote pages --branch gh-pages --push dev
+          else
+            mike deploy --remote pages --branch gh-pages --default dev --push dev
+          fi
+      - name: Publish release documentation
+        if: startsWith(github.ref, 'refs/tags/')
+        env:
+          VERSION: ${{ github.ref_name }}
+        run: |
+          if [[ ! "$VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+            echo "Unsupported documentation release tag: $VERSION" >&2
+            exit 1
+          fi
+          latest=$(git tag --list | grep -E '^[0-9]+\.[0-9]+\.[0-9]+$' | sort -V | tail -n 1)
+          if [[ "$VERSION" == "$latest" ]]; then
+            mike deploy --remote pages --branch gh-pages --update-aliases --push "$VERSION" latest
+            mike set-default --remote pages --branch gh-pages --push latest
+          else
+            mike deploy --remote pages --branch gh-pages --push "$VERSION"
+          fi

.gitignore

@@ -1,5 +1,6 @@
 # Specific
 build/
+site/
 astyle.out
 boards.local.txt
 platform.local.txt

CI/codespell/.codespellignore

@@ -9,4 +9,5 @@ ore
 shiftin
 socio-economic
 DAA
+als
 

README.md

@@ -1,6 +1,6 @@
 # Arduino core support for STM32 based boards
 [![forums](https://img.shields.io/badge/join-the%20forums-blue.svg)](https://www.stm32duino.com/)
-[![wiki](https://img.shields.io/badge/browse-the%20wiki-orange.svg)](https://github.com/stm32duino/Arduino_Core_STM32/wiki)
+[![docs](https://img.shields.io/badge/browse-the%20docs-orange.svg)](https://stm32duino.github.io/latest/)
 [![STM32 Core Continuous Integration](https://github.com/stm32duino/Arduino_Core_STM32/actions/workflows/Arduino-build.yml/badge.svg?branch=main)](https://github.com/stm32duino/Arduino_Core_STM32/actions/workflows/Arduino-build.yml )
 [![Arduino lint status](https://github.com/stm32duino/Arduino_Core_STM32/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/stm32duino/Arduino_Core_STM32/actions/workflows/arduino-lint.yml)
 [![codespell](https://github.com/stm32duino/Arduino_Core_STM32/actions/workflows/CodeSpell.yml/badge.svg)](https://github.com/stm32duino/Arduino_Core_STM32/actions/workflows/CodeSpell.yml)
@@ -16,7 +16,7 @@
 * [Getting Started](https://github.com/stm32duino/Arduino_Core_STM32#getting-started)<br>
 * [Supported boards](https://github.com/stm32duino/Arduino_Core_STM32#supported-boards)<br>
 * [Troubleshooting](https://github.com/stm32duino/Arduino_Core_STM32#troubleshooting)<br>
-* [Wiki](https://github.com/stm32duino/Arduino_Core_STM32/wiki/)
+* [Documentation](https://stm32duino.github.io/latest/)
 
 ## Introduction
 
@@ -43,11 +43,11 @@ https://github.com/stm32duino/BoardManagerFiles/raw/main/package_stmicroelectron
 > [!WARNING]
 > Since core release 2.8.0, only Arduino IDE 2 is supported.
 
-For full instructions on using the "**Boards Manager**", see the [Getting Started](https://github.com/stm32duino/Arduino_Core_STM32/wiki/Getting-Started) page.
+For full instructions on using the "**Boards Manager**", see [Getting Started](https://stm32duino.github.io/latest/Getting-Started/).
 
-Advanced user can use the repository to benefit from the latest development. See the [Using git repository](https://github.com/stm32duino/Arduino_Core_STM32/wiki/Using-git-repository) page.
+Advanced users can use the repository to benefit from the latest development. See [Using git repository](https://stm32duino.github.io/latest/development/Using-git-repository/).
 
-User can add a STM32 based board following this [wiki](https://github.com/stm32duino/Arduino_Core_STM32/wiki/Add-a-new-variant-(board)).
+Users can add an STM32-based board by following [Add a board variant](https://stm32duino.github.io/latest/development/Add-a-new-variant-%28board%29/).
 
 ## Supported boards
 

docs/.codespellignore

@@ -0,0 +1,2 @@
+als
+hsi

docs/.codespellrc

@@ -0,0 +1,5 @@
+[codespell]
+check-filenames =
+check-hidden =
+skip = ./.git
+ignore-words = ./.codespellignore

docs/.gitignore

@@ -0,0 +1 @@
+*.swp