Skip to content

Commit

Permalink
Adding auto generated documentation for lib.
Browse files Browse the repository at this point in the history
  • Loading branch information
gfs committed Mar 30, 2019
1 parent cd32f38 commit 66d3515
Show file tree
Hide file tree
Showing 97 changed files with 29,232 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docfx_project/.gitignore
@@ -0,0 +1,9 @@
###############
# folder #
###############
/**/DROP/
/**/TEMP/
/**/packages/
/**/bin/
/**/obj/
_site
5 changes: 5 additions & 0 deletions docfx_project/api/.gitignore
@@ -0,0 +1,5 @@
###############
# temp file #
###############
*.yml
.manifest
2 changes: 2 additions & 0 deletions docfx_project/api/index.md
@@ -0,0 +1,2 @@
# PLACEHOLDER
TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*!
1 change: 1 addition & 0 deletions docfx_project/articles/intro.md
@@ -0,0 +1 @@
# Add your introductions here!
2 changes: 2 additions & 0 deletions docfx_project/articles/toc.yml
@@ -0,0 +1,2 @@
- name: Introduction
href: intro.md
65 changes: 65 additions & 0 deletions docfx_project/docfx.json
@@ -0,0 +1,65 @@
{
"metadata": [
{
"src": [
{
"cwd": "../",
"files": [
"lib/**.csproj"
]
}
],
"dest": "api",
"disableGitFeatures": false,
"disableDefaultFilter": false
}
],
"build": {
"content": [
{
"files": [
"api/**.yml",
"api/index.md"
]
},
{
"files": [
"articles/**.md",
"articles/**/toc.yml",
"toc.yml",
"*.md"
]
}
],
"resource": [
{
"files": [
"images/**"
]
}
],
"overwrite": [
{
"files": [
"apidoc/**.md"
],
"exclude": [
"obj/**",
"_site/**"
]
}
],
"dest": ".",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"template": [
"default"
],
"postProcessors": [],
"markdownEngineName": "markdig",
"noLangKeyword": false,
"keepFileLink": false,
"cleanupCacheHistory": false,
"disableGitFeatures": false
}
}
4 changes: 4 additions & 0 deletions docfx_project/index.md
@@ -0,0 +1,4 @@
# 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 the *images* folder if the file is referencing an image.
5 changes: 5 additions & 0 deletions docfx_project/toc.yml
@@ -0,0 +1,5 @@
- name: Articles
href: articles/
- name: Api Documentation
href: api/
homepage: api/index.md
374 changes: 374 additions & 0 deletions docs/api/AttackSurfaceAnalyzer.Collectors.BaseCollector.html

Large diffs are not rendered by default.

0 comments on commit 66d3515

Please sign in to comment.