Skip to content

Commit f1fb977

Browse files
author
András Kurai
committed
add docfx
1 parent 9b9809a commit f1fb977

File tree

8 files changed

+92
-0
lines changed

8 files changed

+92
-0
lines changed

Documentation/.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

Documentation/api/.gitignore

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

Documentation/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*!

Documentation/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!

Documentation/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

Documentation/docfx.json

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

Documentation/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.

Documentation/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)