Merge pull request #81 from glopesdev/docfx-update

Update docs website to modern docfx template

.config/dotnet-tools.json

@@ -0,0 +1,12 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "docfx": {
+      "version": "2.75.3",
+      "commands": [
+        "docfx"
+      ]
+    }
+  }
+}

.github/workflows/build.yml

@@ -10,32 +10,35 @@ jobs:
   build:
     runs-on: windows-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4.1.1
         name: Checkout
         with:
           submodules: recursive
 
       - name: Setup MSBuild
-        uses: microsoft/setup-msbuild@v1
+        uses: microsoft/setup-msbuild@v2
 
       - name: Restore NuGet Packages
         run: msbuild -t:restore src\bonsai\Bonsai.sln
 
-      - name: Setup DocFX
-        uses: crazy-max/ghaction-chocolatey@v1
+      - name: Setup .NET Core SDK
+        uses: actions/[email protected]
         with:
-          args: install docfx
+          dotnet-version: 7.x
+
+      - name: Setup DocFX
+        run: dotnet tool restore
 
       - name: Build Documentation
-        run: docfx docfx.json
+        run: dotnet docfx docfx.json
 
       - name: Checkout gh-pages
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4.1.1
         with:
           ref: gh-pages
           path: gh-pages
       - name: Publish to github pages
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v3.9.3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: _site

.gitmodules

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

LICENSE-CODE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024 Bonsai Foundation CIC
+Copyright (c) 2022-2024 Bonsai Foundation CIC and Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

NOTICE

@@ -4,7 +4,7 @@ Attribution-ShareAlike 4.0 International license included in the LICENSE file.
 This repository also includes build automation and deployment software which
 is released under the following license:
 
-Copyright (C) 2022 Gonçalo Lopes
+Copyright (c) 2022-2024 Bonsai Foundation CIC and Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docfx.json

@@ -66,7 +66,9 @@
       }
     ],
     "globalMetadata": {
+      "_enableSearch": true,
       "_enableNewTab": true,
+      "_appFooter": "&copy; 2024 Bonsai Foundation CIC and Contributors. Licensed under <a href=\"https://creativecommons.org/licenses/by-sa/4.0/\">CC BY-SA 4.0</a>. Made with <a href=\"https://dotnet.github.io/docfx\">docfx</a>",
       "_gitContribute": {
         "repo": "https://github.com/bonsai-rx/docs",
         "branch": "main",
@@ -78,9 +80,10 @@
     "fileMetadataFiles": [],
     "template": [
       "default",
+      "modern",
+      "docfx-tools/template",
       "template"
     ],
-    "postProcessors": [ "ExtractSearchIndex" ],
     "markdownEngineName": "markdig",
     "markdownEngineProperties": {
       "markdigExtensions": [
@@ -92,8 +95,8 @@
     "keepFileLink": false,
     "cleanupCacheHistory": false,
     "disableGitFeatures": false,
-    "xrefService": [ "https://xref.docs.microsoft.com/query?uid={uid}" ],
     "xref": [
+      "https://learn.microsoft.com/en-us/dotnet/.xrefmap.json",
       "https://horizongir.github.io/opencv.net/xrefmap.yml",
       "https://horizongir.github.io/ZedGraph/xrefmap.yml",
       "https://horizongir.github.io/opentk/xrefmap.yml",

index.md

@@ -3,7 +3,7 @@
 Bonsai is a visual language for reactive programming. It is lightweight and easy to use with a variety of packages and modules for interfacing with hardware and for real-time processing and manipulation of data streams.
 
 > [!Warning]
-> These docs are under active development, feel free to contribute by either [raising an issue](https://github.com/bonsai-rx/docs/issues) or following the links saying **Improve this Doc**.
+> These docs are under active development, feel free to contribute by either [raising an issue](https://github.com/bonsai-rx/docs/issues) or following the links saying **Edit this page**.
 
 ## Quick Start
 

template/public/main.css

@@ -0,0 +1,21 @@
+@import "workflow.css";
+
+/* ==========================================================================
+   DESIGN GUIDELINES STYLE
+   ========================================================================== */
+
+.do > p::before {
+  content: "✔️ DO ";
+}
+
+.consider > p::before {
+  content: "✔️ CONSIDER ";
+}
+
+.avoid > p::before {
+  content: "❌ AVOID ";
+}
+
+.donot > p::before {
+  content: "❌ DO NOT ";
+}