diff --git a/.gitignore b/.gitignore index 47e27ec2..06ec9814 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +# docfx +api/ +public/ + ## Ignore Visual Studio temporary files, build results, and ## files generated by popular Visual Studio add-ons. ## diff --git a/docfx.json b/docfx.json new file mode 100644 index 00000000..ab5a48f8 --- /dev/null +++ b/docfx.json @@ -0,0 +1,44 @@ +{ + "metadata": [ + { + "src": [ + { + "src": "src", + "files": [ + "**/*.csproj" + ] + } + ], + "dest": "api" + } + ], + "build": { + "content": [ + { + "files": [ + "**/*.{md,yml}" + ], + "exclude": [ + "public/**" + ] + } + ], + "resource": [ + { + "files": [ + "images/**" + ] + } + ], + "output": "public", + "template": [ + "default", + "modern" + ], + "globalMetadata": { + "_appName": "Socially Distant OS", + "_appTitle": "Socially Distant OS", + "_enableSearch": true, + } + } +} diff --git a/docs/getting-started.md b/docs/getting-started.md new file mode 100644 index 00000000..8b3a7945 --- /dev/null +++ b/docs/getting-started.md @@ -0,0 +1 @@ +# Getting Started \ No newline at end of file diff --git a/docs/introduction.md b/docs/introduction.md new file mode 100644 index 00000000..f6ecaa67 --- /dev/null +++ b/docs/introduction.md @@ -0,0 +1 @@ +# Introduction \ No newline at end of file diff --git a/docs/toc.yml b/docs/toc.yml new file mode 100644 index 00000000..d3663b90 --- /dev/null +++ b/docs/toc.yml @@ -0,0 +1,4 @@ +- name: Introduction + href: introduction.md +- name: Getting Started + href: getting-started.md \ No newline at end of file diff --git a/index.md b/index.md new file mode 100644 index 00000000..6023cdd3 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/toc.yml b/toc.yml new file mode 100644 index 00000000..6da36ae1 --- /dev/null +++ b/toc.yml @@ -0,0 +1,4 @@ +- name: Docs + href: docs/ +- name: API + href: api/ \ No newline at end of file