Setup initial mkdocs

Author: hsoerensen

.github/workflows/publish_mkdocs.yml

@@ -0,0 +1,32 @@
+name: Publish mkdocs to gh-pages
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: sudo apt-get install libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev pngquant
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material
+      - run: pip3 install mkdocs-git-revision-date-localized-plugin mkdocs-git-authors-plugin "mkdocs-material[imaging]"
+      - run: mkdocs gh-deploy --force

.gitignore

@@ -1,2 +1,2 @@
-# learn_more
+# learn-more
 Learn more section of website

README.md

@@ -1,8 +1,8 @@
 # yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
-site_name: Voi Swarm
-site_description: Create and run a Voi Network Participation Node
-site_url: https://voinetwork.github.io/voi-swarm/
-repo_url: https://github.com/VoiNetwork/voi-swarm
+site_name: Learn More
+site_description: Learn More about Voi
+site_url: https://voinetwork.github.io/learn-more/
+repo_url: https://github.com/VoiNetwork/learn-more
 edit_uri: edit/main/docs/
 
 theme:
@@ -81,10 +81,10 @@ markdown_extensions:
 
 plugins:
   - search
-  - social:
-      cards_layout: default/variant
-      cards_layout_options:
-        background_color: "#702AE2"
+#  - social:
+#      cards_layout: default/variant
+#      cards_layout_options:
+#        background_color: "#702AE2"
   - git-revision-date-localized:
       enabled: true
       enable_creation_date: true