DocFx ссылочная уценка другой проект - PullRequest
Новая
       41

DocFx ссылочная уценка другой проект

1 голос
/ 14 июня 2019

Мы работаем над мультипроектным * .sln решением и можем успешно сгенерировать документацию API с статьями * .md для него, используя DocFx в отдельном веб-csproj Asp.Net только для документации.

Но мы хотим поддерживать и ссылаться на локальные статьи Markdown * .md и изображения в отдельных проектах * .csproj, а также ссылаться на них и повторно использовать их на глобальном сайте документации, но каким-то образом мы получаем только файлы * .md из Папка / Articles в Web.csproj.

Вот текущий файл docfx.json. Как вы видите, мы пытаемся ссылаться на изображения и файлы уценки из другого проекта

"../ Generator / MyDocService.Contracts / **. Png" и

"../ Генератор / MyDocService.Contracts / *. Md",

но ни один из них не отображается в нашей папке "obj" или "_site". 

{
  "metadata": [
    {
      "src": [
        {
          "files": [
            "*.csproj"
          ],
          "src": "../Generator/GenBasics",
          "exclude": [
            "**/obj/**",
            "**/bin/**",
            "_site/**"
          ]
        },
        {
          "files": [
            "*.csproj"
          ],
          "src": "../DocFrameworkCore/GenCore",
          "exclude": [
            "**/obj/**",
            "**/bin/**",
            "_site/**"
          ]
        },
        {
          "files": [
            "*.csproj"
          ],
          "src": "../Generator/GenImpl",
          "exclude": [
            "**/obj/**",
            "**/bin/**",
            "_site/**"
          ]
        },
        {
          "files": [
            "*.csproj"
          ],
          "src": "../DocFrameworkCore/GenCoreBasics",
          "exclude": [
            "**/obj/**",
            "**/bin/**",
            "_site/**"
          ]
        },
        {
          "files": [
            "*.csproj",
            "**.md",
            "**.png"
          ],
          "src": "../Generator/MyDocService.Contracts",
          "exclude": [
            "**/obj/**",
            "**/bin/**",
            "_site/**"
          ]
        }
      ],
      "filter": "filterConfig.yml",
      "dest": "obj/api"
    }
  ],
  "build": {
    "content": [
      {
        "files": [
          "api/**.yml"
        ],
        "cwd": "obj"
      },
      {
        "files": [
          "api/*.md",
          "articles/**.md",
          "../Generator/MyDocService.Contracts/*.md",
          "toc.yml",
          "*.md"
        ],
        "exclude": [
          "obj/**",
          "_site/**"
        ]
      }
    ],
    "resource": [
      {
        "files": [
          "../Generator/MyDocService.Contracts/**.png",
          "images/**"
        ],
        "exclude": [
          "obj/**",
          "_site/**"
        ]
      }
    ],
    "overwrite": [
      {
        "files": [
          "apidoc/**.md"
        ],
        "exclude": [
          "obj/**",
          "_site/**"
        ]
      }
    ],
    "dest": "_site",
    "globalMetadata": {
      "_appTitle": "MyDoc API",
      "_appFooter": "",
      "_appLogoPath": "images/My.png",
      "_appFaviconPath": "favicon.ico",
      "_enableSearch": true,
      "_disableContribution": true
    },
    "template": [
      "default",
      "docfx-tmpl/src"
    ]
  }
}

1 Ответ

0 голосов
/ 22 июня 2019

Единственный способ сделать распределенные файлы * .md из все доступные подпроекты заключались в том, чтобы поместить docfx.json в корень решения.

...