docs: add docfx

Author: AlphaBs

.github/ISSUE_TEMPLATE/deploy.yml

@@ -0,0 +1,49 @@
+# 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 docfx.json
+
+    - name: Upload site
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: '_site'
+
+    - name: Upload metadata
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: 'api'
+
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4

.gitignore

@@ -262,3 +262,7 @@ __pycache__/
 
 ./release
 benchmark/BenchmarkDotNet.Artifacts/
+
+# DocFX
+api
+_site

docfx.json

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