Skip to content

Commit aaa6971

Browse files
committed
Added documentation infrastructure code
1 parent 5687a82 commit aaa6971

File tree

10 files changed

+106
-0
lines changed

10 files changed

+106
-0
lines changed

docs/serve_docs.cmd

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
@echo off
2+
echo "This script uses docfx - Please make sure it is installed on your machine"
3+
docfx site/docfx.json
4+
docfx serve site/_site

docs/site/.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/site/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

docs/site/api/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Api Documentation
2+
Here you will find an overview over all exposed objects.

docs/site/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/site/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/site/docfx.json

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
{
2+
"metadata": [
3+
{
4+
"src": [
5+
{
6+
"files": [
7+
"LinkDotNet.StringBuilder/LinkDotNet.StringBuilder.csproj"
8+
],
9+
"src": "../../src"
10+
}
11+
],
12+
"dest": "api",
13+
"disableGitFeatures": false,
14+
"disableDefaultFilter": false
15+
}
16+
],
17+
"build": {
18+
"content": [
19+
{
20+
"files": [
21+
"api/**.yml",
22+
"api/index.md"
23+
]
24+
},
25+
{
26+
"files": [
27+
"articles/**.md",
28+
"articles/**/toc.yml",
29+
"toc.yml",
30+
"*.md"
31+
]
32+
}
33+
],
34+
"resource": [
35+
{
36+
"files": [
37+
"images/**"
38+
]
39+
}
40+
],
41+
"overwrite": [
42+
{
43+
"files": [
44+
"apidoc/**.md"
45+
],
46+
"exclude": [
47+
"obj/**",
48+
"_site/**"
49+
]
50+
}
51+
],
52+
"dest": "_site/",
53+
"globalMetadataFiles": [],
54+
"fileMetadataFiles": [],
55+
"template": [
56+
"default"
57+
],
58+
"globalMetadata": {
59+
"_appName": "ValueStringBuilder",
60+
"_appTitle": "ValueStringBuilder",
61+
"_description": "The ValueStringBuilder is a fast and low allocating StringBuilder meant for scenarios where every allocation and millisecond is important.",
62+
"_enableSearch": true,
63+
"_appLogoPath": "/images/logo.png",
64+
"_disableBreadcrumb": true,
65+
"_disableFooter": false
66+
},
67+
"postProcessors": [],
68+
"markdownEngineName": "markdig",
69+
"noLangKeyword": false,
70+
"keepFileLink": false,
71+
"cleanupCacheHistory": false,
72+
"disableGitFeatures": false
73+
}
74+
}

docs/site/images/logo.png

2.05 KB
Loading

docs/site/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/site/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)