Skip to content

Commit 8d6b7cc

Browse files
docfx init -q
1 parent 4090b28 commit 8d6b7cc

9 files changed

Lines changed: 102 additions & 0 deletions

File tree

docs/help/.gitignore

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
###############
2+
# folder #
3+
###############
4+
/**/DROP/
5+
/**/TEMP/
6+
/**/packages/
7+
/**/bin/
8+
/**/obj/
9+
_site

docs/help/api/.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
###############
2+
# temp file #
3+
###############
4+
*.yml

docs/help/api/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# PLACEHOLDER
2+
TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*!

docs/help/api/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- name: TO BE REPLACED
2+
- href: index.md

docs/help/articles/intro.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Add your introductions here!

docs/help/articles/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- name: Introduction
2+
href: intro.md

docs/help/docfx.json

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
{
2+
"metadata": [
3+
{
4+
"src": [
5+
{
6+
"files": [
7+
"src/**.csproj"
8+
],
9+
"exclude": [
10+
"**/obj/**",
11+
"**/bin/**",
12+
"_site/**"
13+
]
14+
}
15+
],
16+
"dest": "api"
17+
}
18+
],
19+
"build": {
20+
"content": [
21+
{
22+
"files": [
23+
"api/**.yml",
24+
"api/index.md"
25+
]
26+
},
27+
{
28+
"files": [
29+
"articles/**.md",
30+
"articles/**/toc.yml",
31+
"toc.yml",
32+
"*.md"
33+
],
34+
"exclude": [
35+
"obj/**",
36+
"_site/**"
37+
]
38+
}
39+
],
40+
"resource": [
41+
{
42+
"files": [
43+
"images/**"
44+
],
45+
"exclude": [
46+
"obj/**",
47+
"_site/**"
48+
]
49+
}
50+
],
51+
"overwrite": [
52+
{
53+
"files": [
54+
"apidoc/**.md"
55+
],
56+
"exclude": [
57+
"obj/**",
58+
"_site/**"
59+
]
60+
}
61+
],
62+
"dest": "_site",
63+
"globalMetadataFiles": [],
64+
"fileMetadataFiles": [],
65+
"template": [
66+
"default"
67+
],
68+
"postProcessors": [],
69+
"noLangKeyword": false,
70+
"keepFileLink": false,
71+
"cleanupCacheHistory": false
72+
}
73+
}

docs/help/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# This is the **HOMEPAGE**.
2+
Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files.
3+
## Quick Start Notes:
4+
1. Add images to the *images* folder if the file is referencing an image.

docs/help/toc.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
- name: Articles
2+
href: articles/
3+
- name: Api Documentation
4+
href: api/
5+
homepage: api/index.md

0 commit comments

Comments
 (0)