feat: API Docs + CommentConverter

.github/workflows/box2d-docs-github.yml

@@ -0,0 +1,44 @@
+# More GitHub Actions for Azure: https://github.com/Azure/actions
+
+name: Build Box2D Docs for GitHub Pages
+
+env:
+  COMMON_SETTINGS_PATH: docs/docfx.json
+
+on:
+  workflow_dispatch:
+
+jobs:
+  publish-docs:
+    runs-on: windows-latest
+
+    steps:
+    - name: .NET SDK Setup
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: 9.x
+
+    - name: Checkout Box2D.NET
+      uses: actions/checkout@v4
+
+    - name: Run Box2D.NET.CommentConverter.csproj
+      run: dotnet run --project tools/Box2D.NET.CommentConverter/Box2D.NET.CommentConverter.csproj --configuration Release
+
+    - name: Install DocFX
+      # This installs the latest version of DocFX and may introduce breaking changes
+      # run: dotnet tool update -g docfx
+      # This installs a specific, tested version of DocFX.
+      run: dotnet tool update -g docfx --version 2.78.2
+
+    - name: Build Box2D.NET API Docs
+      run: docfx metadata ${{ env.COMMON_SETTINGS_PATH }}
+
+    - name: Build Box2D.NET Docs
+      run: docfx build ${{ env.COMMON_SETTINGS_PATH }}
+
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v4.0.0
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/_site
+        publish_branch: gh-pages

.gitignore

@@ -1,4 +1,4 @@
-## Ignore Visual Studio temporary files, build results, and
+## Ignore Visual Studio temporary files, build results, and
 ## files generated by popular Visual Studio add-ons.
 ##
 ## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore
@@ -399,3 +399,7 @@ FodyWeavers.xsd
 .idea/
 imgui.ini
 settings.ini
+
+# DocFX API Generated Pages
+docs/api/*
+docs/_site/*

docs/docfx.json

@@ -0,0 +1,63 @@
+{
+  "$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
+  "metadata": [
+    {
+      "src": [
+        {
+          "src": "..",
+          "files": [
+            "src/Box2D.NET/Box2D.NET.csproj"
+          ]
+        }
+      ],
+      "dest": "api"
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "**/*.{md,yml}"
+        ],
+        "exclude": [
+          "_site/**"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "favicon-32x32.png",
+          "favicon-16x16.png",
+          "images/**"
+        ]
+      }
+    ],
+    "output": "_site",
+    "template": [
+      "default",
+      "modern",
+      "template"
+    ],
+    "fileMetadata": {
+      "_appTitle": {
+        "api/**/*.md": "Box2D API",
+        "api/**/*.yml": "Box2D API"
+      }
+    },
+    "globalMetadata": {
+      "_appName": "",
+      "_appTitle": "Box2D Docs",
+      "_appLogoPath": "images/box2d_logo.svg",
+      "_appFaviconPath": "favicon-32x32.png",
+      "_enableSearch": true,
+      "pdf": false,
+      "_gitContribute": {
+        "repo": "https://github.com/ikpil/Box2D.NET",
+        "branch": "master"
+      },
+      "_gitUrlPattern": "github",
+      "_gitRepo": "https://github.com/ikpil/Box2D.NET"
+    }
+  }
+}

docs/docs/index.md

@@ -0,0 +1,4 @@
+---
+_disableToc: false
+---
+# Box2D.NET Docs

docs/docs/toc.yml

@@ -0,0 +1,8 @@
+- name: 📚 Docs
+  href: index.md
+- name: Original Box2D
+  href: https://box2d.org/
+- name: Overview
+  href: https://box2d.org/documentation/index.html
+- name: FAQ
+  href: https://box2d.org/documentation/md_faq.html

docs/index.md

@@ -0,0 +1,4 @@
+---
+_disableToc: false
+---
+[!INCLUDE [readme](../readme.md)]

docs/template/public/main.css

@@ -0,0 +1,5 @@
+/* Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License. See License.txt in the project root for license information. */
+
+.navbar-brand #logo {
+    height: 56px;
+}

docs/template/public/main.js

@@ -0,0 +1,17 @@
+const app = {
+    languageDropdownCreated: false,
+    iconLinks: [
+        {
+            icon: 'github',
+            href: 'https://github.com/ikpil/Box2D.NET',
+            title: 'GitHub'
+        },
+        {
+            icon: 'discord',
+            href: 'https://github.com/ikpil/Box2D.NET',
+            title: 'Discord'
+        }
+    ]
+};
+
+export default app;

docs/toc.yml

@@ -0,0 +1,4 @@
+- name: 📚 Docs
+  href: docs/index.md
+- name: 🔧 API
+  href: api/

tools/Box2D.NET.CommentConverter/Box2D.NET.CommentConverter.csproj

@@ -0,0 +1,10 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net9.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+</Project>