Merge pull request #3 from MinBZK/feature/add-mkdocs

Adds mkdocs

.github/workflows/main.yaml

@@ -0,0 +1,19 @@
+name: Publish mkdocs via GitHub Pages
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: pages-build-deployment
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout main
+        uses: actions/checkout@v4
+
+      - name: Deploy MkDocs
+        uses: mhausenblas/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          REQUIREMENTS: requirements.txt

docs/index.md

@@ -0,0 +1,16 @@
+---
+title: AI Validation
+summary: Documenting the processes of the AI Validation Team at the Ministry of the Interior and Kingdom Relations (Min BZK) in The Netherlands.
+---
+
+# AI Validation
+
+Here we are documenting the processes of the AI Validation Team at the Ministry of the Interior and Kingdom Relations (Min BZK) in The Netherlands.
+
+
+!!! info "Disclaimer"
+
+    This documention is under development
+
+## Contribute?
+We work open source at [GitHub](https://github.com/MinBZK/ai-validation).

mkdocs.yml

@@ -0,0 +1,64 @@
+### Site metadata ###
+
+site_name: AI Validation
+site_description: Documenting the processes of the AI Validation Team at the Ministry of the Interior and Kingdom Relations (Min BZK) in The Netherlands.
+
+### theme settings ###
+theme:
+    name: material
+    language: en
+    palette:
+        primary: blue
+    features:
+        - navigation.indexes
+        - navigation.tabs
+        - navigation.tabs.sticky
+        - navigation.path
+        - navigation.top
+        - navigation.tracking
+        # - navigation.footer
+        - search.highlight
+        - search.suggest
+        - content.action.edit
+    icon:
+        logo: fontawesome/solid/house
+        annotation: fontawesome/solid/circle-info
+
+# Navigation for the site
+nav:
+    - Home: index.md
+    - Way of Working:
+        - wow/principles.md
+
+markdown_extensions:
+    - pymdownx.tabbed:
+        alternate_style: true
+    - pymdownx.superfences
+    - pymdownx.details
+    - admonition
+    - attr_list
+    - abbr
+    - md_in_html
+    - pymdownx.tasklist:
+        custom_checkbox: true
+    - pymdownx.emoji:
+        emoji_index: !!python/name:material.extensions.emoji.twemoji
+        emoji_generator: !!python/name:material.extensions.emoji.to_svg
+    - pymdownx.snippets:
+        auto_append:
+            - includes/abbreviations.md
+
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/MinBZK/ai-validation
+
+
+plugins:
+    - glightbox
+    - search
+    - git-revision-date-localized:
+        enable_creation_date: true
+
+repo_url: https://github.com/MinBZK/ai-validation
+edit_uri: edit/main/docs/

requirements.txt

@@ -0,0 +1,7 @@
+mkdocs==1.5.3
+mkdocs-git-revision-date-localized-plugin==1.2.2
+mkdocs-glightbox==0.3.6
+mkdocs-material==9.5.4
+mkdocs-material-extensions==1.3.1
+pymdown-extensions==10.7
+Jinja2>=2.11.1