Описание тега docfx
Docfx - это инструмент для создания документации из проектов Visual Studio и смешивания их с пользовательскими статьями с помощью разметки. Если вы столкнулись с ошибкой или у вас есть запрос на добавление функции, пожалуйста, откройте проблему на GitHub.
2
ответа
Как сгенерировать документацию для других проектов в рамках решения с использованием DocFx
Я использую DocFx для автоматического создания документации в Visual Studio 2015. В соответствии с инструкциями по началу работы я добавил пустое веб-приложение ASP.NET 4 и использовал консоль Nuget для установки пакета сборки DocFx (например, Insta…
23 фев '16 в 22:02
1
ответ
PlantUml не отображает диаграмму после сборки docfx
https://github.com/KevReed/DocFx.Plugins.PlantUml Я установил plantUml для плагина docfx через nuget. от nuget install DocFx.Plugins.PlantUml -ExcludeVersion -OutputDirectory . команда, после этого я получил этот результат после сборки docfx, и я п…
23 окт '18 в 06:10
1
ответ
Справочник по Docfx API - не разрешает тег
Я следовал этому руководству, чтобы создать документацию по API для библиотеки классов. В комментариях моей библиотеки классов я использовал тег see, чтобы ссылаться на другие типы.Например, это комментарий класса, содержащего методы расширения для …
02 окт '16 в 13:20
1
ответ
Таблицы формата DOCFX с использованием уценки без изменения шаблона
Можно ли изменить раскладку таблицы с помощью уценки под docfx? Например, следующая таблица не очень хорошо читается из-за расстояния между столбцами. В событии отсутствует чередующийся цвет строки: | Property | Description | |---|---| | URL | `/api…
10 мар '16 в 12:28
2
ответа
Вывод DocFX в Markdown
Глядя на поток, DocFX, кажется, создает файлы.md, а затем преобразует их в html при создании документации. Есть ли способ сделать вывод DocFX в файлы.md вместо HTML?
29 июн '16 в 16:27
1
ответ
Использование docfx.console не может генерировать документацию
Я установил docfx.console через менеджер пакетов nuget (visual studios 2017 15.7.3) в тестовый проект. Мой проект - это библиотека.net с единичным классом с небольшим количеством XML-документации. Когда я собираю проект, он создает файл _site с файл…
09 июн '18 в 22:53
1
ответ
Непрерывное развертывание документации DocFx с использованием локальной TFS
Я изо всех сил пытаюсь настроить процесс непрерывного развертывания для проекта DocFX, используя локальную TFS. Процесс описан здесь, однако пример пошагового руководства для VSTS, и у меня есть локальная TFS (версия 2013). Основная идея заключается…
31 авг '18 в 16:28
1
ответ
Docfx, как сделать так, чтобы он правильно отображал символы?
Я собираю документацию с помощью DocFx из Visual Studio с пакетом NuGet. Я пишу по-итальянски, и у нас много таких персонажей, как: à è ì ò ù, В финальном рендере моя страница выглядит так: Окончательный HTML выглядит так: Как я могу сделать так, чт…
03 ноя '16 в 08:26
0
ответов
Как сгенерировать документацию с помощью DocFX, используя файл документации XML?
Я хочу создать что-то вроде веб-сайта с документацией по API для проекта.NET. Согласно .NET Docs, XML-комментарии, которые мы помещаем поверх методов, классов и т. Д., Могут быть обработаны компилятором в XML-файл, и этот файл можно запустить с помо…
28 дек '18 в 23:51
1
ответ
Относительный путь DocFX к папке 'src'
В конфигурации DocFX мне чего-то не хватает - поэтому он не генерирует надлежащую документацию. У меня есть следующая структура папок: +Documentation |- _site |- api |- apidoc |- articles |- images |- src <-- This folder is autogenerated by `docf…
24 апр '17 в 13:18
1
ответ
Как создавать ссылки на код с пользовательским текстом ссылки в комментариях к документации?
Я портирую библиотеку приложений с Java на C#. В документации Java есть места, которые ссылаются на конкретную ссылку на код, используя пользовательский текст. Например: Suffix --&gt; {@link DataOutput#writeString String} Я попытался использоват…
21 июн '17 в 08:10
0
ответов
docfx.console подавляет сборку в некоторых случаях
У меня есть проект dotnet core 2.1, с которым я использую docfx.console. Я люблю инструмент, но хочу, чтобы он был внутренним. Я также хотел бы подавить это в моем конвейере CD в режиме выпуска. Есть ли способ помешать созданию сайта на основе парам…
13 окт '18 в 02:04
0
ответов
Как заставить Microsoft DocFX работать в Visual Studio
Я скачал DocFX и установил его с http://dotnet.github.io/docfx/. Я добавил его в мой путь к среде. Затем я скачал образец решения с https://github.com/docascode/docfx-seed и открыл его как проект веб-сайта. (Этот образец уже содержит пакет docfx.msb…
17 мар '16 в 23:04
0
ответов
Как добавить маркеры или нумерованный список в статье DocFx?
Я хочу добавить маркеры и пронумерованные списки в моем документе DocFx. Как я могу это сделать?
17 авг '18 в 20:29
1
ответ
Как я могу настроить документацию Docfx (темы или шаблоны)?
Я только начал использовать Docfx и создал базовую концептуальную документацию. Теперь я хочу внести некоторые коррективы в тему (логотип компании, возможно, некоторые изменения шрифта и т. Д.) Незначительные вещи. Официальная документация только да…
17 мар '16 в 16:23
1
ответ
Почему мои пользовательские файлы шаблонов не применяются docfx при сборке с пользовательским шаблоном, указанным в docfx.json?
На сайте документации docfx показано, как настроить различные.partial файлы, используемые в шаблоне по умолчанию (см. https://dotnet.github.io/docfx/tutorial/walkthrough/advanced_walkthrough.html). Я следовал этим инструкциям, создав новую папку с ш…
15 ноя '18 в 18:33
2
ответа
Как изменить нижний колонтитул в DocFX?
Просто надейтесь изменить информацию об авторских правах нижнего колонтитула, созданную DocFX. Вот что я сделал: Шаблон экспорта: Бежать docfx template export defaultполучить папку _exported_templates\default Измените части нижнего колонтитула: Файл…
07 июл '17 в 18:23
1
ответ
Как понизить многословность docfx?
Мы используем docfx, он включен как nuget в один из наших файлов csproj. Я лично не настраивал эту штуку, и у меня больше нет информации о том, как она работает, но похоже, что это простой добавленный в проект Cget nuget, который затем создает докум…
04 дек '18 в 12:44
2
ответа
Как создать централизованное хранилище документации кода с возможностью поиска с использованием DocFx
Я хочу создать центральное хранилище для всей нашей опубликованной документации по API с использованием DocFx. У меня есть документация, автоматически сгенерированная с помощью моей сборки (с использованием TFS) и опубликованная с помощью моей верси…
25 июл '17 в 20:00
1
ответ
Как отключить DocFX в visual studio в режиме отладки, пока активен в режиме релиза?
Я добавил DocFX в Visual Studio для создания веб-документов для моего кода C#. Однако для каждой компиляции создаются новые документы, что занимает много времени. Есть ли способ отключить его в visual studio, когда он мне не нужен? Я знаю, что можно…
24 дек '18 в 10:49