feat: Add mkdocs layer + gh action to publish skyscrapers/platform#1213

Add mkdocs layer + gh action to publish

Add requirements

Add requirements

Add requirements

Update mkdocs build

Update mkdocs build

Update mkdocs build

Update mkdocs build

Add assets

Do not built strict

.github/workflows/publish.yml

@@ -0,0 +1,38 @@
+name: publish
+on:
+  push:
+    branches:
+      - master
+permissions:
+  contents: write
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download source
+        uses: actions/checkout@v4
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+      - name: Build site
+        run: mkdocs build
+      - name: Upload to GitHub Pages
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: site
+  deploy:
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}

mkdocs.yaml

@@ -0,0 +1,61 @@
+site_name: Skyscrapers Documentation
+docs_dir: .
+site_url: https://docs.skyscrapers.eu
+repo_url: https://github.com/skyscrapers/documentation
+theme:
+  logo: assets/favicon.png
+  favicon: assets/favicon.png
+  name: material
+  font:
+    text: Inter
+    code: Source Code Pro
+  palette:
+    primary: custom
+  features:
+    - navigation.instant
+    - navigation.instant.prefetch
+    - navigation.expand
+    - navigation.prune
+    - navigation.top
+    - navigation.indexes
+    - toc.follow
+    - search.suggest
+    - search.highlight
+    - search.share
+    - content.action.view
+    - content.action.edit
+    - content.code.annotate
+    - content.code.copy
+    - content.tooltips
+    - toc.follow
+extra_css:
+  - stylesheets/extra.css
+plugins:
+  - awesome-pages
+  - social
+  - tags
+  - same-dir
+  - search:
+      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/skyscrapers/documentation
+      name: Skyscrapers Documentation GitHub Repository
+    - icon: fontawesome/brands/linkedin
+      link: https://www.linkedin.com/company/skyscrapers
+      name: Skyscrapers LinkedIn
+    - icon: fontawesome/solid/globe
+      link: https://skyscrapers.eu
+      name: Skyscrapers Website
+  generator: false
+edit_uri: edit/master/
+markdown_extensions:
+  - toc:
+      permalink: true
+      permalink_title: Anchor link to this section for reference
+  - admonition
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.superfences

requirements.txt

@@ -0,0 +1,9 @@
+mkdocs==1.6.0
+mkdocs-awesome-pages-plugin==2.9.2
+mkdocs-get-deps==0.2.0
+mkdocs-git-authors-plugin==0.9.0
+mkdocs-material==9.5.26
+mkdocs-material-extensions==1.3.1
+pillow==10.3.0
+CairoSVG==2.7.1
+mkdocs-same-dir

stylesheets/extra.css

@@ -0,0 +1,5 @@
+:root {
+  --md-primary-fg-color:        #172B76;
+  --md-primary-fg-color--light: #172B76;
+  --md-primary-fg-color--dark:  #172B76;
+}