Merge pull request #6 from J-Tech-Japan/docfx_simple_settings

Docfx Simple settings
J-Tech-Japan · May 26, 2023 · 5ba7f6a · 5ba7f6a
2 parents 1450fc5 + 9931fb2
commit 5ba7f6a
Show file tree

Hide file tree

Showing 8 changed files with 86 additions and 0 deletions.
diff --git a/docs/docfx_project/.gitignore b/docs/docfx_project/.gitignore
@@ -0,0 +1,10 @@
+###############
+#    folder   #
+###############
+/**/DROP/
+/**/TEMP/
+/**/packages/
+/**/bin/
+/**/obj/
+
+_site
diff --git a/docs/docfx_project/api/.gitignore b/docs/docfx_project/api/.gitignore
@@ -0,0 +1,5 @@
+###############
+#  temp file  #
+###############
+*.yml
+.manifest
diff --git a/docs/docfx_project/api/index.md b/docs/docfx_project/api/index.md
@@ -0,0 +1,2 @@
+# PLACEHOLDER
+TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*!
diff --git a/docs/docfx_project/articles/intro.md b/docs/docfx_project/articles/intro.md
@@ -0,0 +1 @@
+# Add your introductions here!
diff --git a/docs/docfx_project/articles/toc.yml b/docs/docfx_project/articles/toc.yml
@@ -0,0 +1,2 @@
+- name: Introduction
+  href: intro.md
diff --git a/docs/docfx_project/docfx.json b/docs/docfx_project/docfx.json
@@ -0,0 +1,57 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "files": [
+            "**/*.csproj"
+          ],
+          "src" : "../../src"
+        }
+      ],
+      "dest": "api",
+      "includePrivateMembers": false,
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false,
+      "noRestore": false,
+      "namespaceLayout": "flattened",
+      "memberLayout": "samePage",
+      "allowCompilationErrors": false
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "api/**.yml",
+          "api/index.md"
+        ]
+      },
+      {
+        "files": [
+          "articles/**.md",
+          "articles/**/toc.yml",
+          "toc.yml",
+          "*.md"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "images/**"
+        ]
+      }
+    ],
+    "output": "_site",
+    "globalMetadataFiles": [],
+    "fileMetadataFiles": [],
+    "template": [
+      "default",
+      "modern"
+    ],
+    "postProcessors": [],
+    "keepFileLink": false,
+    "disableGitFeatures": false
+  }
+}
diff --git a/docs/docfx_project/index.md b/docs/docfx_project/index.md
@@ -0,0 +1,4 @@
+# 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.
diff --git a/docs/docfx_project/toc.yml b/docs/docfx_project/toc.yml
@@ -0,0 +1,5 @@
+- name: Articles
+  href: articles/
+- name: Api Documentation
+  href: api/
+  homepage: api/index.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# PLACEHOLDER
		TODO: Add .NET projects to the src folder and run `docfx` to generate REAL API Documentation!