switch to docfx

loresoft · Aug 29, 2023 · 4853a60 · 4853a60
1 parent 0f2a2fb
commit 4853a60
Show file tree

Hide file tree

Showing 16 changed files with 115 additions and 12 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -13,16 +13,19 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Dotnet Setup
+        uses: actions/setup-dotnet@v3
         with:
-          python-version: 3.x
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
-      - uses: actions/cache@v3
+          dotnet-version: 7.x
+
+      - run: dotnet tool update -g docfx
+      - run: docfx docs/docfx.json
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
         with:
-          key: mkdocs-material-${{ env.cache_id }}
-          path: .cache
-          restore-keys: |
-            mkdocs-material-
-      - run: pip install mkdocs-material
-      - run: mkdocs gh-deploy --force
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/_site
diff --git a/.gitignore b/.gitignore
@@ -244,3 +244,4 @@ coverage.xml
 coverage.opencover.xml
 *.received.txt
 .idea
+_site
diff --git a/docs/docfx.json b/docs/docfx.json
@@ -0,0 +1,64 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "files": [
+            "src/FluentCommand/bin/Release/net7.0/FluentCommand.dll",
+            "src/FluentCommand.SqlServer/bin/Release/net7.0/FluentCommand.SqlServer.dll",
+            "src/FluentCommand.Json/bin/Release/net7.0/FluentCommand.Json.dll"
+          ],
+          "src": "../"
+        }
+      ],
+      "dest": "reference"
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "reference/**.yml",
+          "reference/index.md"
+        ]
+      },
+      {
+        "files": [
+          "guide/**.md",
+          "guide/**/toc.yml",
+          "toc.yml",
+          "*.md"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "assets/**"
+        ]
+      }
+    ],
+    "postProcessors": [
+      "ExtractSearchIndex"
+    ],
+    "globalMetadata": {
+      "_appTitle": "FluentCommand",
+      "_appName": "FluentCommand",
+      "_appFooter": "Copyright &copy; 2023 LoreSoft",
+      "_appLogoPath": "assets/logo.png",
+      "_appFaviconPath": "assets/logo.png",
+      "_enableSearch": true
+    },
+    "sitemap": {
+      "baseUrl": "https://loresoft.com/FluentCommand",
+      "priority": 0.5,
+      "changefreq": "daily"
+    },
+    "output": "_site",
+    "template": [
+      "default",
+      "modern",
+      "template"
+    ]
+  }
+}
diff --git a/docs/cache.md → docs/guide/cache.md b/docs/cache.md → docs/guide/cache.md
diff --git a/docs/configuration.md → docs/guide/configuration.md b/docs/configuration.md → docs/guide/configuration.md
@@ -2,7 +2,7 @@
 
 Configuration for SQL Server
 
-```c#
+```cs
 IDataConfiguration dataConfiguration  = new DataConfiguration(
     SqlClientFactory.Instance, 
     ConnectionString

diff --git a/docs/execute.md → docs/guide/execute.md b/docs/execute.md → docs/guide/execute.md
diff --git a/docs/generation.md → docs/guide/generation.md b/docs/generation.md → docs/guide/generation.md
diff --git a/docs/logging.md → docs/guide/logging.md b/docs/logging.md → docs/guide/logging.md
diff --git a/docs/parameter.md → docs/guide/parameter.md b/docs/parameter.md → docs/guide/parameter.md
diff --git a/docs/query.md → docs/guide/query.md b/docs/query.md → docs/guide/query.md
diff --git a/docs/sql.md → docs/guide/sql.md b/docs/sql.md → docs/guide/sql.md
diff --git a/docs/guide/toc.yml b/docs/guide/toc.yml
@@ -0,0 +1,16 @@
+- name: Configuration
+  href: configuration.md
+- name: SQL Builder
+  href: sql.md
+- name: Parameters
+  href: parameter.md
+- name: Execute
+  href: execute.md
+- name: Queries
+  href: query.md
+- name: Caching
+  href: cache.md
+- name: Logging
+  href: logging.md
+- name: Generation
+  href: generation.md
diff --git a/docs/reference/.gitignore b/docs/reference/.gitignore
@@ -0,0 +1,2 @@
+*.yml
+.manifest
diff --git a/docs/reference/index.md b/docs/reference/index.md
@@ -0,0 +1,3 @@
+# FluentCommand Reference
+
+The API Reference Documentation
diff --git a/docs/template/public/main.css b/docs/template/public/main.css
@@ -0,0 +1,9 @@
+#logo {
+  width: 50px;
+  height: 50px;
+  margin-right: 0.5em;
+}
+
+#breadcrumb {
+  display: none;
+}
diff --git a/docs/toc.yml b/docs/toc.yml
@@ -0,0 +1,5 @@
+- name: User Guide
+  href: guide/
+- name: Reference
+  href: reference/
+  homepage: reference/index.md