Update docfx config

Apollo3zehn · Feb 21, 2024 · 5c5b93e · 5c5b93e
1 parent df9b583
commit 5c5b93e
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 240 deletions.
diff --git a/doc/docfx.json b/doc/docfx.json
@@ -6,24 +6,26 @@
           "files": [
             "**/*.csproj"
           ],
-          "src": "./../src"
+          "src": "../src"
         }
       ],
-      "dest": "./api",
+      "dest": "api",
       "filter": "filterConfig.yml",
       "properties": {
         "TargetFramework": "netstandard2.1"
-      }
+      },
+      "includePrivateMembers": false,
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false,
+      "noRestore": false,
+      "namespaceLayout": "flattened",
+      "memberLayout": "samePage",
+      "EnumSortOrder": "alphabetic",
+      "allowCompilationErrors": false
     }
   ],
   "build": {
     "content": [
-      {
-        "files": [
-          "*.md",
-          "toc.yml"
-        ]
-      },
       {
         "files": [
           "api/**.yml",
@@ -33,7 +35,9 @@
       {
         "files": [
           "samples/**.md",
-          "samples/**/toc.yml"
+          "samples/**/toc.yml",
+          "toc.yml",
+          "*.md"
         ]
       }
     ],
@@ -44,15 +48,20 @@
         ]
       }
     ],
-    "dest": "_site",
+    "output": "_site",
     "globalMetadata": {
       "_appTitle": "FluentModbus",
-      "_appFooter": "Copyright © 2019 Vincent Wilms",
-      "_appFaviconPath": "images/icon.ico",
+      "_appFooter": "Copyright © 2024 Vincent Wilms",
+      "_appFaviconPath": "images/icon.png",
       "_appLogoPath": "images/logo.svg"
     },
     "fileMetadataFiles": [],
-    "template":["default","templates/material"],
-    "markdownEngineName": "markdig"
+    "template": [
+      "default",
+      "modern"
+    ],
+    "postProcessors": [],
+    "keepFileLink": false,
+    "disableGitFeatures": false
   }
 }
diff --git a/doc/samples/modbus_tcp.md b/doc/samples/modbus_tcp.md
@@ -156,7 +156,7 @@ static void DoClientWork(ModbusTcpClient client, ILogger logger)
     Span<byte> data;
 
     var sleepTime = TimeSpan.FromMilliseconds(100);
-    var unitIdentifier = 0xFF;
+    var unitIdentifier = 0x00;
     var startingAddress = 0;
     var registerAddress = 0;
 

diff --git a/doc/templates/material/partials/head.tmpl.partial b/doc/templates/material/partials/head.tmpl.partial
diff --git a/doc/templates/material/styles/main.css b/doc/templates/material/styles/main.css
diff --git a/doc/toc.yml b/doc/toc.yml
@@ -1,5 +1,5 @@
 - name: Samples
   href: samples/
 
-- name: Api Documentation
+- name: API
   href: api/