docs: docfx manual migration

RadicalCSG · Apr 30, 2024 · e0b4b1c · e0b4b1c
1 parent 4ab9534
commit e0b4b1c
Show file tree

Hide file tree

Showing 68 changed files with 2,556 additions and 8,885 deletions.
diff --git a/Documentation~/docfx/.gitignore → Documentation~/.gitignore b/Documentation~/docfx/.gitignore → Documentation~/.gitignore
diff --git a/Documentation~/docfx/Makefile → Documentation~/Makefile b/Documentation~/docfx/Makefile → Documentation~/Makefile
@@ -2,8 +2,8 @@ install:
 	dotnet tool update -g docfx
 
 copy: 
-	cp ../../CHANGELOG.md changelog/
-	cp ../../LICENSE.md license/
+	cp ../CHANGELOG.md changelog/
+	cp ../LICENSE.md license/
 
 build: copy
 	docfx docfx.json

diff --git a/Documentation~/docfx/README.md → Documentation~/README.md b/Documentation~/docfx/README.md → Documentation~/README.md
@@ -1,7 +1,7 @@
 # Documentation
 
 1. Place `.dll` files for `Unity`, `Burst`, `Collections`, etc. in the `dlls/` folder.
-2. Navigate to the `Documentation~/docfx` folder.
+2. Navigate to the `Documentation~/` folder.
 3. Build documentation using `docfx`. Optionally, if `make` is available, run `make serve` to build and open documentation in the browser.
 
 > [!NOTE]  

diff --git a/Documentation~/docfx/api/andywiecko.md → Documentation~/api/andywiecko.md b/Documentation~/docfx/api/andywiecko.md → Documentation~/api/andywiecko.md
diff --git a/Documentation~/api/index.md b/Documentation~/api/index.md
@@ -0,0 +1,6 @@
+
+<p align="center"><img src="../images/burst-triangulator-logo-light-mode.svg"/></p>
+
+---
+
+This is the documentation for the Scripting APIs of this package.
diff --git a/Documentation~/docfx/changelog/toc.yml → Documentation~/changelog/toc.yml b/Documentation~/docfx/changelog/toc.yml → Documentation~/changelog/toc.yml
diff --git a/Documentation~/docfx/dlls/.gitignore → Documentation~/dlls/.gitignore b/Documentation~/docfx/dlls/.gitignore → Documentation~/dlls/.gitignore
diff --git a/Documentation~/docfx/docfx.json → Documentation~/docfx.json b/Documentation~/docfx/docfx.json → Documentation~/docfx.json
@@ -1,7 +1,7 @@
 {
   "metadata": [
     {
-      "src": [{"src": "../../Runtime", "files": ["**/*.cs"]}],
+      "src": [{"src": "../Runtime", "files": ["**/*.cs"]}],
       "dest": "api",
       "allowCompilationErrors": true,
       "memberLayout": "separatePages",
@@ -13,8 +13,13 @@
       "https://learn.microsoft.com/en-us/dotnet/.xrefmap.json",
       "unity-xrefmap.yml"
     ],
+    "markdownEngineName": "markdig",
+    "markdownEngineProperties": {
+      "markdigExtensions": [ "footnotes" ]
+    },
     "content": [
       {"files": ["*.md", "toc.yml"]},
+      {"src": "manual", "files": ["*.yml", "*.md", "**/*.md"], "dest": "manual"},
       {"src": "api", "files": ["*.yml", "index.md", "andywiecko.md"], "dest": "api"},
       {"src": "changelog", "files": ["toc.yml", "CHANGELOG.md"], "dest": "changelog"},
       {"src": "license", "files": ["toc.yml", "LICENSE.md"], "dest": "license"}

diff --git a/Documentation~/docfx/api/index.md b/Documentation~/docfx/api/index.md
diff --git a/Documentation~/docfx/images/burst-triangulator-logo-light-mode.svg b/Documentation~/docfx/images/burst-triangulator-logo-light-mode.svg
diff --git a/Documentation~/docfx/index.md b/Documentation~/docfx/index.md
diff --git a/Documentation~/guitar-dt-dark.svg b/Documentation~/guitar-dt-dark.svg
diff --git a/Documentation~/guitar-dt-light.svg b/Documentation~/guitar-dt-light.svg
diff --git a/Documentation~/guitar.svg b/Documentation~/guitar.svg