Added documentation infrastructure code

linkdotnet · Apr 4, 2022 · aaa6971 · aaa6971
1 parent 5687a82
commit aaa6971
Show file tree

Hide file tree

Showing 10 changed files with 106 additions and 0 deletions.
diff --git a/docs/serve_docs.cmd b/docs/serve_docs.cmd
@@ -0,0 +1,4 @@
+@echo off
+echo "This script uses docfx - Please make sure it is installed on your machine"
+docfx site/docfx.json
+docfx serve site/_site
diff --git a/docs/site/.gitignore b/docs/site/.gitignore
@@ -0,0 +1,9 @@
+###############
+#    folder   #
+###############
+/**/DROP/
+/**/TEMP/
+/**/packages/
+/**/bin/
+/**/obj/
+_site
diff --git a/docs/site/api/.gitignore b/docs/site/api/.gitignore
@@ -0,0 +1,5 @@
+###############
+#  temp file  #
+###############
+*.yml
+.manifest
diff --git a/docs/site/api/index.md b/docs/site/api/index.md
@@ -0,0 +1,2 @@
+# Api Documentation
+Here you will find an overview over all exposed objects.
diff --git a/docs/site/articles/intro.md b/docs/site/articles/intro.md
@@ -0,0 +1 @@
+# Add your introductions here!
diff --git a/docs/site/articles/toc.yml b/docs/site/articles/toc.yml
@@ -0,0 +1,2 @@
+- name: Introduction
+  href: intro.md
diff --git a/docs/site/docfx.json b/docs/site/docfx.json
@@ -0,0 +1,74 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "files": [
+            "LinkDotNet.StringBuilder/LinkDotNet.StringBuilder.csproj"
+          ],
+          "src": "../../src"
+        }
+      ],
+      "dest": "api",
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "api/**.yml",
+          "api/index.md"
+        ]
+      },
+      {
+        "files": [
+          "articles/**.md",
+          "articles/**/toc.yml",
+          "toc.yml",
+          "*.md"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "images/**"
+        ]
+      }
+    ],
+    "overwrite": [
+      {
+        "files": [
+          "apidoc/**.md"
+        ],
+        "exclude": [
+          "obj/**",
+          "_site/**"
+        ]
+      }
+    ],
+    "dest": "_site/",
+    "globalMetadataFiles": [],
+    "fileMetadataFiles": [],
+    "template": [
+      "default"
+    ],
+    "globalMetadata": {
+      "_appName": "ValueStringBuilder",
+      "_appTitle": "ValueStringBuilder",
+      "_description": "The ValueStringBuilder is a fast and low allocating StringBuilder meant for scenarios where every allocation and millisecond is important.",
+      "_enableSearch": true,
+      "_appLogoPath": "/images/logo.png",
+      "_disableBreadcrumb": true,
+      "_disableFooter": false
+    },
+    "postProcessors": [],
+    "markdownEngineName": "markdig",
+    "noLangKeyword": false,
+    "keepFileLink": false,
+    "cleanupCacheHistory": false,
+    "disableGitFeatures": false
+  }
+}
diff --git a/docs/site/images/logo.png b/docs/site/images/logo.png
diff --git a/docs/site/index.md b/docs/site/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/site/toc.yml b/docs/site/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 @@
		# Api Documentation
		Here you will find an overview over all exposed objects.