Вывод DocFX в Markdown

Question

Вывод DocFX в Markdown

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

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

6

docfx

Источник

user245189 29 июн '16 в 16:27

2 ответа

Другие вопросы по тегам docfx

user1247579 04 окт '23 в 17:42 2023-10-04 17:42 · Answer 1 · 2023-10-04 17:42

Экспериментальная поддержка генерации уценки была добавлена в docfx начиная с версии 2.71.0 .

2

Источник

user1247579 04 окт '23 в 17:42

user546745 30 июн '16 в 07:10 2016-06-30 07:10 · Answer 2 · 2016-06-30 07:10

Обновление: я должен неправильно понять этот вопрос в моем оригинальном ответе. На самом деле, это все еще открытый запрос 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.