Документерра позволяет импортировать документацию, созданную с помощью docfx — инструмента, который автоматически генерирует документацию для ваших файлов исходного кода на C#, VB и других поддерживаемых языках. Это позволяет, например, создавать справочник для вашего C# SDK в системе Документерра.
В качестве результата docfx создает архив с файлами HTML-страниц. Этот раздел проведет вас через процесс импорта в Документерру.
Миграция и импорт данных — это не одно и то же. Импорт — это инструмент, который значительно ускоряет процесс миграции, но является только его частью. Всегда следует вручную проверять каждый импорт, чтобы убедиться, что не отсутствует контент и что стилизация сохранена там, где это необходимо. В Документерре мы предоставляем услуги миграции данных. Свяжитесь с нами по почте sales@documenterra.ru, если вы заинтересованы! |
Docfx также может создавать PDF-файлы, которые можно импортировать в Документерру, однако в этом случае структура оглавления будет утрачена при импорте. При использовании архива HTML-файлов процесс импорта сохраняет исходную структуру оглавления, стили и скрипты. Поэтому мы рекомендуем использовать именно архив HTML-файлов для импорта.
Чтобы импортировать документацию, созданную с помощью docfx, выполните следующие шаги:
- Нажмите кнопку Импорт на странице Проекты или кнопку Импортировать в нижнем левом углу Редактора страниц.
- В мастере импорта выберите опцию docfx.
- Если вы создаете новый проект, введите его название в поле названия проекта и укажите язык проекта.
- Нажмите Дальше, затем перетащите файл в область для загрузки файлов или нажмите на нее, чтобы выбрать файл на вашем компьютере.
- Нажмите Дальше и перейдите к третьему шагу, на котором выполняется импорт.
- После завершения вы можете перейти к проекту, нажав Открыть проект, или закрыть мастер, нажав Готово.