Вывод DocFX в Markdown

Глядя на поток, кажется, что DocFX создает файлы .md, а затем конвертирует их в html при создании документации.

Есть ли способ сделать вывод DocFX в файлы .md вместо html?


person Orn Kristjansson    schedule 29.06.2016    source источник


Ответы (1)


Обновление: я должен неправильно понять этот вопрос в своем первоначальном ответе. На самом деле, это все еще открытый запрос функции DocFX, которого трудно достичь с текущей архитектурой.

См.: https://github.com/dotnet/docfx/issues/684.


Исходный ответ:

Вы должны переместить файлы .md из content в resource в docfx.json.

В качестве примера возьмем фрагмент кода docfx.json. Все файлы .md в articles будут преобразованы в .html на выходе.

...
"build": {
  "content": [
    {
      "files": ["articles/**.md"]
    }
  ]
}
...

Если вы надеетесь, что articles/sample.md останется непреобразованным, вы можете изменить docfx.json, как показано ниже:

...
"build": {
  "content": [
    {
      "files": ["articles/**.md"],
      "exclude": ["articles/sample.md"]
    }
  ]
  "resource": [
    {
      "files": ["articles/sample.md"]
    }
  ]
}
...

Дополнительную информацию можно найти на странице пользователя DocFX. Руководство.

person Yuby    schedule 30.06.2016