Skip to content

Instantly share code, notes, and snippets.

@agc93
Created August 27, 2016 01:46
Show Gist options
  • Save agc93/2acbf62f78b5712441cca42f39cf77e4 to your computer and use it in GitHub Desktop.
Save agc93/2acbf62f78b5712441cca42f39cf77e4 to your computer and use it in GitHub Desktop.
DocFX config file formats
{
"metadata": [
{
"src": [
{
"files": [
"src/**.sln"
],
"exclude": [
"**/obj/**",
"**/bin/**",
"docfx/**"
],
"cwd": "../"
}
],
"dest": "api"
}
],
"build": {
"content": [
{
"files": [
"api/**.yml",
"api/index.md"
]
},
{
"files": [
"doc/**.md",
"doc/**/toc.yml"
],
"exclude": [
"obj/**",
"_site/**"
]
},
{
"files": [
"toc.yml",
"*.md"
],
"exclude": [
"obj/**",
"_site/**"
]
}
],
"resource": [
{
"files": [
"assets/**"
],
"exclude": [
"obj/**",
"_site/**"
]
}
],
"overwrite": [
{
"files": [
"apidoc/**.md"
],
"exclude": [
"obj/**",
"_site/**"
]
}
],
"dest": "_site",
"template": [
"default"
],
"noLangKeyword": false
}
}
---
metadata:
- src:
- files:
- src/**.sln
exclude:
- "**/obj/**"
- "**/bin/**"
- docfx/**
cwd: "../"
dest: api
build:
content:
- files:
- api/**.yml
- api/index.md
- files:
- doc/**.md
- doc/**/toc.yml
exclude:
- obj/**
- _site/**
- files:
- toc.yml
- "*.md"
exclude:
- obj/**
- _site/**
resource:
- files:
- assets/**
exclude:
- obj/**
- _site/**
overwrite:
- files:
- apidoc/**.md
exclude:
- obj/**
- _site/**
dest: _site
template:
- default
noLangKeyword: false
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment