Merge pull request #19 from harp-tech/modern-theme

Add docfx-tools template and update website layout

Author: glopesdev

.config/dotnet-tools.json

@@ -3,10 +3,11 @@
   "isRoot": true,
   "tools": {
     "docfx": {
-      "version": "2.73.1",
+      "version": "2.78.2",
       "commands": [
         "docfx"
-      ]
+      ],
+      "rollForward": false
     }
   }
 }

.github/workflows/build.yml

@@ -27,7 +27,7 @@ jobs:
       - name: Setup .NET Core SDK
         uses: actions/setup-dotnet@v4
         with:
-          dotnet-version: 7.x
+          dotnet-version: 8.x
 
       - name: Custom Build Steps
         run: .\build.ps1

.gitmodules

@@ -40,3 +40,6 @@
 [submodule "python"]
 	path = python
 	url = https://github.com/harp-tech/harp-python.git
+[submodule "docfx-tools"]
+	path = docfx-tools
+	url = https://github.com/bonsai-rx/docfx-tools.git

articles/intro.md

@@ -1,28 +1,24 @@
-- name: About
-  items:
-    - name: What is Harp
-      href: about.md
+- name: Get started
+- name: Basic Concepts
+  href: about.md
+- name: Quick Start
+  href: ../index.md
 - name: Protocol
-  items:
-    - name: Binary Protocol
-      href: ~/protocol/BinaryProtocol-8bit.md
-    - name: Common Registers
-      href: ~/protocol/Device.md
-    - name: Synchronization Clock
-      href: ~/protocol/SynchronizationClock.md
+- name: Binary Protocol
+  href: ../protocol/BinaryProtocol-8bit.md
+- name: Common Registers
+  href: ../protocol/Device.md
+- name: Synchronization Clock
+  href: ../protocol/SynchronizationClock.md
 - name: Control Interface
-  items:
-    - name: Quickstart
-      href: intro.md
-    - name: Operators
-      href: operators.md
-    - name: Firmware
-      href: firmware.md
-    - name: Logging
-      href: logging.md
-    - name: Message Manipulation
-      href: message-manipulation.md
+- name: Operators
+  href: operators.md
+- name: Firmware
+  href: firmware.md
+- name: Logging
+  href: logging.md
+- name: Message Manipulation
+  href: message-manipulation.md
 - name: Data Interface
-  items:
-    - name: Python
-      href: python.md
+- name: Python
+  href: python.md

articles/toc.yml

@@ -16,9 +16,7 @@
       ],
       "dest": "api",
       "filter": "filter.yml",
-      "enumSortOrder": "declaringOrder",
-      "disableGitFeatures": false,
-      "disableDefaultFilter": false
+      "enumSortOrder": "declaringOrder"
     }
   ],
   "build": {
@@ -47,8 +45,6 @@
     "resource": [
       {
         "files": [
-          "logo.svg",
-          "favicon.ico",
           "src/device.*/Assets/*.png",
           "src/device.*/Assets/*.jpg",
           "protocol/assets/**",
@@ -78,7 +74,7 @@
     "globalMetadata": {
       "_enableNewTab": true,
       "_enableSearch": true,
-      "_appFooter": "<span>&copy; 2023 harp-tech and Contributors</span> - <span>Licensed under <a href=\"https://creativecommons.org/licenses/by-sa/4.0/\">CC BY-SA 4.0</a>.</span> - <span>Made with <a href=\"https://dotnet.github.io/docfx\">docfx</a></span>",
+      "_appFooter": "<span>&copy; 2025 harp-tech and Contributors</span> - <span>Licensed under <a href=\"https://creativecommons.org/licenses/by-sa/4.0/\">CC BY-SA 4.0</a>.</span> - <span>Made with <a href=\"https://dotnet.github.io/docfx\">docfx</a></span>",
       "_gitContribute": {
         "repo": "https://github.com/harp-tech/harp-tech.github.io",
         "branch": "main",
@@ -91,9 +87,9 @@
     "template": [
       "default",
       "modern",
+      "docfx-tools/template",
       "template"
     ],
-    "postProcessors": [ "ExtractSearchIndex" ],
     "markdownEngineName": "markdig",
     "markdownEngineProperties": {
       "markdigExtensions": [