json DocFX配置文件格式

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了json DocFX配置文件格式相关的知识,希望对你有一定的参考价值。

---
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
  }
}

以上是关于json DocFX配置文件格式的主要内容,如果未能解决你的问题,请参考以下文章

docfx

docfx 做一个和微软一样的文档平台

.net core读取json格式的配置文件

docfx 做一个和微软一样的文档平台

.NET6使用DOCFX根据注释自动生成开发文档

IT项目中使用 json格式数据 保存项目配置信息, 在配置文件再读取json文件的内容进行赋值