Browse Source

Add basic docFx setup

tags/1.0-rc
Christopher F 8 years ago
parent
commit
0ee102a376
10 changed files with 110 additions and 0 deletions
  1. +10
    -0
      docs/.gitignore
  2. +5
    -0
      docs/api/.gitignore
  3. +1
    -0
      docs/api/.manifest
  4. +3
    -0
      docs/api/index.md
  5. +2
    -0
      docs/articles/intro.md
  6. +3
    -0
      docs/articles/toc.yml
  7. +70
    -0
      docs/docfx.json
  8. +5
    -0
      docs/filterConfig.yml
  9. +5
    -0
      docs/index.md
  10. +6
    -0
      docs/toc.yml

+ 10
- 0
docs/.gitignore View File

@@ -0,0 +1,10 @@

###############
# folder #
###############
/**/DROP/
/**/TEMP/
/**/packages/
/**/bin/
/**/obj/
_site

+ 5
- 0
docs/api/.gitignore View File

@@ -0,0 +1,5 @@

###############
# temp file #
###############
*.yml

+ 1
- 0
docs/api/.manifest
File diff suppressed because it is too large
View File


+ 3
- 0
docs/api/index.md View File

@@ -0,0 +1,3 @@

# PLACEHOLDER
TODO: Add .NET projects to *src* folder and run `docfx` to generate a **REAL** *API Documentation*!

+ 2
- 0
docs/articles/intro.md View File

@@ -0,0 +1,2 @@

# Add your introductions here!

+ 3
- 0
docs/articles/toc.yml View File

@@ -0,0 +1,3 @@

- name: Introduction
href: intro.md

+ 70
- 0
docs/docfx.json View File

@@ -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
}
}

+ 5
- 0
docs/filterConfig.yml View File

@@ -0,0 +1,5 @@
apiRules:
- exclude:
uidRegex: ^Discord\.API$
- exclude:
uidRegex: ^Discord\.API.*$

+ 5
- 0
docs/index.md View File

@@ -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.

+ 6
- 0
docs/toc.yml View File

@@ -0,0 +1,6 @@

- name: Articles
href: articles/
- name: Api Documentation
href: api/
homepage: api/index.md

Loading…
Cancel
Save