Added content to README.md

README.md

@@ -0,0 +1,28 @@
+<p align="center">
+  <a href="https://stephan.hadan.de">
+    <img src="https://github.com/stiebke/stiebke.github.io/blob/main/docs/assets/logo.png" width="192" alt="Stephan Hadan">
+  </a>
+</p>
+
+<p align="center">
+  <strong>
+    Stephan Hadan's 
+    <a href="https://stephan.hadan.de/">private Website</a>
+  </strong>
+</p>
+
+<p align="center">
+  <a href="https://github.com/stiebke/stiebke.github.io/actions"><img
+    src="https://github.com/stiebke/stiebke.github.io/actions/workflows/ci.yml/badge.svg"
+    alt="Build"
+  /></a>
+</p>
+
+<p align="center">
+  <a href="https://squidfunk.github.io/mkdocs-material/"><img
+    src="https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white"
+    alt="Built with Material for MkDocs"
+  /></a>
+</p>
+
+[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/)

mkdocs.yml

@@ -1,8 +1,39 @@
+# Copyright (c) 2024 Stephan Hadan <stephan@hadan.de>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+# Project information
 site_name: Stephan Hadan
 site_url: https://stephan.hadan.de/
+site_author: Stephan Hadan
+site_description: >-
+  Write your documentation in Markdown and create a professional static site in
+  minutes – searchable, customizable, in 60+ languages, for all devices
+
+# Repository
 repo_url: https://github.com/stiebke/stiebke.github.io
 repo_name: stiebke/stiebke.github.io
 
+# Copyright
+copyright: Copyright &copy; 2024 Stephan Hadan
+
+# Configuration
 theme:
   name: material
   palette: 
@@ -27,13 +58,12 @@ theme:
     - search.suggest
     - search.highlight
     - search.share
-copyright: Copyright &copy; 2024 Stephan Hadan
 
+# Plugins
 plugins:
   - search
   - blog: 
       archive: false
-#  - social
   - git-revision-date-localized:
       enable_creation_date: true
   - git-committers:
@@ -48,8 +78,6 @@ plugins:
           covers:
             front: resources/templates/covers/front.html.j2
             back: resources/templates/covers/back.html.j2
-#          browser:
-#            debug: false
           aggregator:
             enabled: !ENV [MKDOCS_EXPORTER_PDF_AGGREGATOR, true]
             output: documentation.pdf
@@ -60,16 +88,19 @@ plugins:
           enabled: !!python/name:mkdocs_exporter.formats.pdf.buttons.download.enabled
           attributes: !!python/name:mkdocs_exporter.formats.pdf.buttons.download.attributes
 
+# Additional configuration
 extra:
   social:
     - icon: fontawesome/brands/github
       link: https://github.com/stiebke
     - icon: fontawesome/brands/linkedin
       link: https://de.linkedin.com/in/stiebke
+    - icon: fontawesome/brands/bluesky
       link: https://bsky.app/profile/stiebke.bsky.social
     - icon: fontawesome/brands/mastodon
       link: https://freiburg.social/@stiebke 
-    
+
+# Extensions    
 markdown_extensions:
   - abbr
   - pymdownx.betterem