Merge pull request #31 from AutumnSky1010/prepare/#30

#30 Prepare DocFX

.github/workflows/deploy_doc.yml

@@ -0,0 +1,28 @@
+name: DocFX Build and Publish
+
+on:
+  workflow_dispatch
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Setup .NET Core
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: 8.0.x
+
+    - name: Install DocFX
+      run: dotnet tool install -g docfx
+
+    - name: Build Documentation
+      run: docfx docs/docfx.json
+
+    - name: Deploy to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/_site

.gitignore

@@ -364,4 +364,8 @@ FodyWeavers.xsd
 /Shinko.cs
 
 # VS Code workspace
-SoundMaker.code-workspace
+SoundMaker.code-workspace
+
+# API Reference
+_site
+api

docs/docfx.json

@@ -0,0 +1,45 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "src": "../src/SoundMaker",
+          "files": [
+            "**/*.csproj"
+          ]
+        }
+      ],
+      "dest": "api"
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "**/*.{md,yml}"
+        ],
+        "exclude": [
+          "_site/**"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "images/**"
+        ]
+      }
+    ],
+    "output": "_site",
+    "template": [
+      "default",
+      "modern"
+    ],
+    "globalMetadata": {
+      "_appName": "SoundMaker API Reference",
+      "_appTitle": "SoundMaker API Reference",
+      "_enableSearch": true,
+      "pdf": false
+    }
+  }
+}

docs/index.md

@@ -0,0 +1,11 @@
+---
+_layout: landing
+---
+
+# This is the **HOMEPAGE**.
+
+Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files.
+
+## Quick Start Notes:
+
+1. Add images to the *images* folder if the file is referencing an image.

docs/markdowns/getting-started.md

@@ -0,0 +1 @@
+# Getting Started

docs/markdowns/introduction.md

@@ -0,0 +1 @@
+# Introduction

docs/markdowns/toc.yml

@@ -0,0 +1,4 @@
+- name: Introduction
+  href: introduction.md
+- name: Getting Started
+  href: getting-started.md

docs/toc.yml

@@ -0,0 +1,4 @@
+- name: Docs
+  href: markdowns/
+- name: API
+  href: api/