📝 docs: 初始化文档生成和发布流程

- 新增 DocFX 配置文件和 GitHub Actions 工作流
- 创建基本的文档结构和目录
- 设置 API 文档生成和发布到 GitHub Pages
- 移除 global.json 文件

Author: jianxuanbing

.github/workflows/dofx.yml

@@ -0,0 +1,62 @@
+name: docfx
+on:
+  push:
+    branches:
+      - "main"
+      - "master"
+      - "dev"
+
+# 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 the 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:
+  build:
+    name: "publish docs"
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      # Check out the branch that triggered this workflow to the 'source' subdirectory
+      - name: Checkout Code
+        uses: actions/checkout@v4
+      - name: Setup .NET SDK
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: |
+            6.0.x
+            7.0.x
+            8.0.x
+            9.0.x
+      - name: install dotnet tools
+        run: |
+          dotnet tool install -g dotnet-execute
+          dotnet tool install -g docfx
+      # Run a build
+      - name: Build docs
+        run: |
+          dotnet-exec info
+          dotnet build
+          docfx ./docs/docfx.json
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'docs/_site'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+      # - name: cloudflare-pages
+      #   uses: cloudflare/wrangler-action@v3
+      #   with:
+      #     accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+      #     apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+      #     command: pages deploy docs/_site --project-name=bing-utils

docs/ReleaseNotes.md

@@ -0,0 +1 @@
+# Bing.Utils Release Notes

docs/api/.gitignore

@@ -0,0 +1,5 @@
+###############
+#  temp file  #
+###############
+*.yml
+.manifest

docs/api/index.md

@@ -0,0 +1,3 @@
+# PLACEHOLDER
+
+TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*!

docs/docfx.json

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

docs/index.md

@@ -0,0 +1 @@
+# Bing.Utils

docs/introduction.md

@@ -0,0 +1 @@
+# Introduction

docs/toc.yml

@@ -0,0 +1,8 @@
+- name: 主页
+  href: index.md
+- name: API 文档
+  href: api/
+- name: 发行说明
+  href: ReleaseNotes.md
+- name: Github
+  href: https://github.com/bing-framework/Bing.Utils