Skip to content

Instantly share code, notes, and snippets.

@jeffward01
Forked from mdschweda/Folder structure
Created January 15, 2022 08:47
Show Gist options
  • Save jeffward01/3a931f745056badb473631b1f99dea56 to your computer and use it in GitHub Desktop.
Save jeffward01/3a931f745056badb473631b1f99dea56 to your computer and use it in GitHub Desktop.
Multiple projects DocFX structure
{
"metadata": [
{
"src": [
{
"files": "src/ProjectA/**.cs",
"exclude": [
"**/obj/**",
"**/bin/**"
],
"src": ".."
}
],
"dest": "api/ProjectA"
},
{
"src": [
{
"files": "src/ProjectB/**.cs",
"exclude": [
"**/obj/**",
"**/bin/**"
],
"src": ".."
}
],
"dest": "api/ProjectB"
}
],
"build": {
"content": [
{
"files": [
"api/**.yml",
"api/**/index.md"
]
},
{
"files": [
"articles/**.md",
"articles/**/toc.yml",
"toc.yml",
"*.md"
],
"exclude": [
"obj/**",
"bin/**"
]
}
],
"resource": [
{
"files": [
"images/**"
],
"exclude": [
"obj/**"
]
}
],
"overwrite": [
{
"files": [
"apidoc/**.md"
],
"exclude": [
"obj/**"
]
}
],
"dest": "_site",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"template": [
"default"
],
"postProcessors": [],
"noLangKeyword": false
}
}
+-- doc
⁞ +-- api
⁞ ⁞ +-- ProjectA
⁞ ⁞ ⁞ +-- index.md
⁞ ⁞ +-- ProjectB
⁞ ⁞ +-- index.md
⁞ +-- docfx.json
⁞ +-- toc.yml
+-- src
+-- ProjectA
+-- ProjectB
- name: Welcome
href: articles/
- name: Project A
href: api/ProjectA
homepage: api/ProjectA/index.md
- name: Project B
href: api/ProjectB
homepage: api/ProjectB/index.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment