На этой странице вы найдете подробности о специфике импорта из ReadMe — какие элементы поддерживаются, какие нет и что происходит со структурой Дерева страниц.
Специфика импорта структуры дерева страниц
При импорте проекта из ReadMe в Документерру иерархия папок в оглавлении сохраняется, но порядок страниц — нет, поскольку экспортированный архив не включает такую информацию. При необходимости вы можете вручную изменить порядок страниц после импорта.
Поддерживаемые элементы ReadMe
|
Под "поддерживаемыми" элементами мы имеем в виду элементы, специфичные для ReadMe. Обычные элементы, такие как абзацы текста, ссылки, изображения и т. д., здесь не упоминаются, так как они импортируются как есть.
|
Во время импорта Документерра обрабатывает и конвертирует следующие элементы в элементы Документерры:
| Элемент ReadMe |
Элемент Документерры
|
Комментарий
|
|---|---|---|
|
Code blocks
|
Примеры кода
|
|
|
Callouts
|
Экспресс-блоки
|
|
|
Embeds
|
—
|
Вставляются как HTML тег <iframe>
|
|
Page Description
|
—
|
Вставляется как HTML тег <p> с CSS классом description. Тег включает содержимое поля Description страницы ReadMe, если оно не пустое.
|
|
Tabs
|
Вкладки
|
|
Неподдерживаемые элементы ReadMe
Элементы, которые в настоящее время не поддерживаются, импортируются с сохранением их HTML-разметки и содержимого, насколько это возможно. Конкретная функциональность элемента или некоторые части контента могут быть утеряны. Зная разметку, вы сможете найти их с помощью инструмента Глобального поиска и замены и исправить.
Импортирование API документации
В настоящее время автоматический импорт определений API из ReadMe не поддерживается, так как экспортированный архив не включает файл Swagger/OpenAPI или ссылку на него. Справочник API импортируется в виде стандартных страниц. Если страница в проекте ReadMe включает дополнительную информацию, добавленную вручную в теле документации, она также импортируется.
Если вам нужно импортировать ваш файл определения Swagger/OpenAPI в систему Документерра, пожалуйста, обратитесь к этой статье: Импорт спецификаций OpenAPI/Swagger.