| @@ -0,0 +1,10 @@ | |||||
| ############### | |||||
| # folder # | |||||
| ############### | |||||
| /**/DROP/ | |||||
| /**/TEMP/ | |||||
| /**/packages/ | |||||
| /**/bin/ | |||||
| /**/obj/ | |||||
| _site | |||||
| @@ -0,0 +1,5 @@ | |||||
| ############### | |||||
| # temp file # | |||||
| ############### | |||||
| *.yml | |||||
| @@ -0,0 +1,3 @@ | |||||
| # PLACEHOLDER | |||||
| TODO: Add .NET projects to *src* folder and run `docfx` to generate a **REAL** *API Documentation*! | |||||
| @@ -0,0 +1,2 @@ | |||||
| # Add your introductions here! | |||||
| @@ -0,0 +1,3 @@ | |||||
| - name: Introduction | |||||
| href: intro.md | |||||
| @@ -0,0 +1,70 @@ | |||||
| { | |||||
| "metadata": [ | |||||
| { | |||||
| "src": [ | |||||
| { | |||||
| "src": "..", | |||||
| "files": [ | |||||
| "src/**project.json" | |||||
| ], | |||||
| "exclude": [ | |||||
| "**/obj/**", | |||||
| "**/bin/**", | |||||
| "_site/**" | |||||
| ] | |||||
| } | |||||
| ], | |||||
| "dest": "api", | |||||
| "filter": "filterConfig.yml" | |||||
| } | |||||
| ], | |||||
| "build": { | |||||
| "content": [ | |||||
| { | |||||
| "files": [ | |||||
| "api/**.yml", | |||||
| "api/index.md" | |||||
| ] | |||||
| }, | |||||
| { | |||||
| "files": [ | |||||
| "articles/**.md", | |||||
| "articles/**/toc.yml", | |||||
| "toc.yml", | |||||
| "*.md" | |||||
| ], | |||||
| "exclude": [ | |||||
| "obj/**", | |||||
| "_site/**" | |||||
| ] | |||||
| } | |||||
| ], | |||||
| "resource": [ | |||||
| { | |||||
| "files": [ | |||||
| "images/**" | |||||
| ], | |||||
| "exclude": [ | |||||
| "obj/**", | |||||
| "_site/**" | |||||
| ] | |||||
| } | |||||
| ], | |||||
| "overwrite": [ | |||||
| { | |||||
| "files": [ | |||||
| "apidoc/**.md" | |||||
| ], | |||||
| "exclude": [ | |||||
| "obj/**", | |||||
| "_site/**" | |||||
| ] | |||||
| } | |||||
| ], | |||||
| "dest": "_site", | |||||
| "template": [ | |||||
| "default" | |||||
| ], | |||||
| "noLangKeyword": false | |||||
| } | |||||
| } | |||||
| @@ -0,0 +1,5 @@ | |||||
| apiRules: | |||||
| - exclude: | |||||
| uidRegex: ^Discord\.API$ | |||||
| - exclude: | |||||
| uidRegex: ^Discord\.API.*$ | |||||
| @@ -0,0 +1,5 @@ | |||||
| # 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 *images* folder if the file is referencing an image. | |||||
| @@ -0,0 +1,6 @@ | |||||
| - name: Articles | |||||
| href: articles/ | |||||
| - name: Api Documentation | |||||
| href: api/ | |||||
| homepage: api/index.md | |||||