docs: add docfx

Author: AlphaBs

.github/workflows/deploy.yml

@@ -0,0 +1,48 @@
+# Your GitHub workflow file under .github/workflows/
+# Trigger the action on push to main
+on:
+  push:
+    branches:
+      - main
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  actions: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+  
+jobs:
+  publish-docs:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: Dotnet Setup
+      uses: actions/setup-dotnet@v3
+      with:
+        dotnet-version: 8.x
+
+    - run: dotnet tool update -g docfx
+    - run: docfx metadata docfx.json
+    - run: docfx docfx.json
+
+    - name: Copy Metadata into Site Folder
+      run: cp -r docfx-metadata/* docfx-site/docfx-metadata
+
+    - name: Upload site
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: 'docfx-site'
+
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4

.gitignore

@@ -396,3 +396,5 @@ FodyWeavers.xsd
 
 # JetBrains Rider
 *.sln.iml
+
+docfx-output/

docfx.json

@@ -0,0 +1,49 @@
+{
+    "$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
+    "metadata": [
+      {
+        "src": [
+          {
+            "src": ".",
+            "files": [
+              "CmlLib.Core.Commons.csproj"
+            ]
+          }
+        ],
+        "dest": "docfx-output/metadata",
+        "outputFormat": "markdown"
+      }
+    ],
+    "build": {
+      "content": [
+        {
+          "src": "docfx-output/metadata",
+          "files": [
+            "*.{md,yml}"
+          ],
+          "exclude": [
+            "docfx-output/site/**"
+          ],
+          "dest": "api"
+        }
+      ],
+      "resource": [
+        {
+          "files": [
+            "images/**"
+          ]
+        }
+      ],
+      "output": "docfx-output/site",
+      "template": [
+        "default",
+        "modern"
+      ],
+      "globalMetadata": {
+        "_appName": "CmlLib.Core.Commons",
+        "_appTitle": "CmlLib.Core.Commons",
+        "_enableSearch": true,
+        "pdf": false
+      }
+    }
+  }