Skip to content

Commit

Permalink
initial docfx project files (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
StephenHodgson committed Feb 2, 2019
1 parent d1d2a49 commit 4cfee51
Show file tree
Hide file tree
Showing 6 changed files with 113 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docfx_project/.gitignore
@@ -0,0 +1,8 @@
###############
# folder #
###############
/**/DROP/
/**/TEMP/
/**/packages/
/**/bin/
/**/obj/
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*!
88 changes: 88 additions & 0 deletions docfx_project/docfx.json
@@ -0,0 +1,88 @@
{
"metadata": [
{
"src": [
{
"src": "../XRTK-Core",
"exclude": [
"**/Builds/**",
"**/Library/**",
"**/Logs/**",
"**/Packages/**",
"**/ProjectSettings/**",
"**/Temp/**",
"**/ThirdParty/**",
"**/.vs/**"
],
"files": [
"**.sln",
"**.csproj"
]
}
],
"dest": "api",
"disableGitFeatures": false,
"disableDefaultFilter": false
}
],
"build": {
"xref": [
"https://stephenhodgson.github.io/UnityCsReference/xrefmap.yml"
],
"xrefservice": [
"https://xref.docs.microsoft.com/query?uid={uid}"
],
"content": [
{
"files": [
"api/**.yml",
"api/index.md"
]
},
{
"files": [
"toc.yml",
"*.md"
]
}
],
"resource": [
{
"files": [
"images/**"
]
}
],
"overwrite": [
{
"files": [
"apidoc/**.md"
],
"exclude": [
"obj/**",
"../docs/**"
]
}
],
"globalMetadata": {
"_appTitle": "XRTK-Core",
"_appFooter": "(c) 2019 XRTK",
"_gitContribute": {
"repo": "https://github.com/XRTK/XRTK-Core",
"branch": "development"
}
},
"dest": "../docs",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"template": [
"default"
],
"postProcessors": [],
"markdownEngineName": "markdig",
"noLangKeyword": false,
"keepFileLink": false,
"cleanupCacheHistory": false,
"disableGitFeatures": false
}
}
7 changes: 7 additions & 0 deletions docfx_project/index.md
@@ -0,0 +1,7 @@
# 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.
3 changes: 3 additions & 0 deletions docfx_project/toc.yml
@@ -0,0 +1,3 @@
- name: Api Documentation
href: api/
homepage: api/index.md

0 comments on commit 4cfee51

Please sign in to comment.