Docfx

.github/dependabot.yml

@@ -12,3 +12,7 @@ updates:
     package-ecosystem: github-actions
     schedule:
       interval: daily
+  - directory: /
+    package-ecosystem: gitsubmodule
+    schedule:
+      interval: daily

.github/workflows/docs.yml

@@ -0,0 +1,50 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  actions: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  generate-docs:
+    runs-on: ubuntu-latest
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.output.page_url }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+        with:
+          submodules: true
+
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v5
+        with:
+          dotnet-version: 10.x
+
+      - name: Build
+        run: dotnet build -c Release
+
+      - name: DocFX build
+        working-directory: docs
+        run: dnx docfx --yes
+        continue-on-error: false
+
+      - name: Upload assets
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: docs/_site
+
+      - name: Deploy
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "docs/silksong-modding-style-docfx"]
+	path = docs/silksong-modding-style-docfx
+	url = https://github.com/silksong-modding/silksong-modding-style-docfx

README.md

@@ -0,0 +1,7 @@
+# Silksong.ModMenu
+
+The standard menu-modification mod for Silksong. It provides a small but powerful set of features for mods to use.
+
+This mod also adds a 'Mod Options' menu to the main Options menu by default.
+
+For documentation and examples, see the [documentation](https://docs.silksong-modding.org/Silksong.DataManager).

docs/.gitignore

@@ -0,0 +1,8 @@
+/**/DROP/
+/**/TEMP/
+/**/packages/
+/**/bin/
+/**/obj/
+_site
+/api/*.yml
+/api/.manifest

docs/articles/toc.yml

@@ -0,0 +1,2 @@
+- name: Getting Started
+- href: ../index.md

docs/docfx.json

@@ -0,0 +1,48 @@
+{
+  "$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
+  "metadata": [
+    {
+      "src": [
+        {
+          "src": "../Silksong.ModMenu",
+          "files": [
+            "**/*.csproj"
+          ]
+        }
+      ],
+      "dest": "api",
+      "filter": "filterconfig.yml"
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "**/*.{md,yml}"
+        ],
+        "exclude": [
+          "_site/**"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "images/**"
+        ]
+      }
+    ],
+    "output": "_site",
+    "template": [
+      "default",
+      "modern",
+	  "silksong-modding-style-docfx"
+    ],
+    "globalMetadata": {
+      "_appName": "ModMenu",
+      "_appTitle": "ModMenu",
+      "_enableSearch": true,
+      "pdf": false
+    }
+  }
+}

docs/filterconfig.yml

@@ -0,0 +1,4 @@
+### YamlMime:ManagedReference
+apiRules:
+  - exclude:
+      uidRegex: 'Silksong\.ModMenu\.ModMenuPlugin'

docs/index.md

@@ -0,0 +1,29 @@
+# ModMenu
+
+[![NuGet Version](https://img.shields.io/nuget/v/Silksong.ModMenu)](https://www.nuget.org/packages/Silksong.ModMenu)
+
+The standard menu-modification mod for Silksong. It provides a small but powerful set of features for mods to use.
+
+This mod also adds a 'Mod Options' menu to the main Options menu by default.
+
+## Usage
+
+Add the following line to your .csproj:
+```
+<PackageReference Include="Silksong.ModMenu" Version="0.4.5" />
+```
+The most up to date version number can be retrieved from [Nuget](https://www.nuget.org/packages/Silksong.ModMenu).
+
+You will also need to add a dependency to your thunderstore.toml:
+```
+silksong_modding-ModMenu = "0.4.5"
+```
+The version number does not matter hugely, but the most up to date number can be retrieved from
+[Thunderstore](https://thunderstore.io/c/hollow-knight-silksong/p/silksong_modding/ModMenu/).
+If manually uploading, instead copy the dependency string from the Thunderstore link.
+
+ModMenu should be added as a BepInEx dependency by putting the following attribute
+onto your plugin class, below the BepInAutoPlugin attribute.
+```
+[BepInDependency(Silksong.ModMenu.ModMenuPlugin.Id)]
+```

docs/toc.yml

@@ -0,0 +1,4 @@
+- name: Articles
+  href: articles/
+- name: API Documentation
+  href: api/