(#235) Fix for the github actions workflow (#268)

Author: adrianhall

.github/workflows/build-docs.yml

@@ -1,4 +1,4 @@
-name: Deploy documentation site to Pages
+name: Deploy documentation site to GitHub Pages
 
 on:
   push:
@@ -28,8 +28,34 @@ jobs:
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-python@v5
+      - name: Install Python
+        uses: actions/setup-python@v5
         with:
           python-version: 3.x
-      - run: pip install mkdocs
-      - run: mkdocs gh-deploy --clean --force --verbose
+
+      - name: Install mkdocs
+        run: pip install mkdocs
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+
+      - name: Generate site
+        run : mkdocs build -f ./mkdocs.production.yml
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./site
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,6 +1,9 @@
 ### Azure Developer CLI ###
 .azure/
 
+### Mkdocs Site ###
+site/
+
 # Ignore codespaces / C# Dev Kit files
 .mono
 

mkdocs.production.yml

@@ -0,0 +1,56 @@
+site_name: Datasync Community Toolkit
+site_url: https://CommunityToolkit.github.io/Datasync/
+repo_url: https://github.com/CommunityToolkit/Datasync/
+repo_name: GitHub
+
+theme:
+  name: readthedocs
+  highlightjs: true
+  locale: en
+
+validation:
+  omitted_files: warn
+  absolute_links: warn
+  unrecognized_links: warn
+  anchors: warn
+
+nav:
+  - Getting started: index.md
+  - In depth:
+    - Server:
+      - The basics: in-depth/server/index.md
+      - Databases:
+        - Azure SQL: in-depth/server/db/azuresql.md
+        - Cosmos: in-depth/server/db/cosmos.md
+        - In Memory: in-depth/server/db/in-memory.md
+        - LiteDb: in-depth/server/db/litedb.md
+        - MongoDb: in-depth/server/db/mongodb.md
+        - MySQL: in-depth/server/db/mysql.md
+        - PgSQL: in-depth/server/db/pgsql.md
+        - SQLite: in-depth/server/db/sqlite.md
+      - OpenApi:
+        - NSwag: in-depth/server/openapi/nswag.md
+        - Swashbuckle: in-depth/server/openapi/swashbuckle.md
+        - ".NET 9.x": in-depth/server/openapi/net9.md
+    - Client:
+      - The basics: in-depth/client/index.md
+      - Authentication: in-depth/client/auth.md
+      - Online operations: in-depth/client/online.md
+      - Advanced topics:
+        - MAUI AOT: in-depth/client/advanced/maui-aot.md
+  - Samples:
+      - Todo App:
+        - The server: samples/todoapp/server.md
+        - Avalonia: samples/todoapp/avalonia.md
+        - MAUI: samples/todoapp/maui.md
+        - WinUI3: samples/todoapp/winui3.md
+        - WPF: samples/todoapp/wpf.md
+
+markdown_extensions:
+  - smarty: {}
+  - toc:
+      permalink: "#"
+  - sane_lists: {}
+  - fenced_code: {}
+  - tables: {}
+  - admonition: {}

mkdocs.yml

@@ -1,4 +1,5 @@
 site_name: Datasync Community Toolkit
+dev_addr: localhost:7000
 
 theme:
   name: readthedocs