ReadMe Import Specifics
In this topic you can find details about ReadMe import specifics — what elements are supported, what elements are not, and what happens with the TOC structure.
TOC Structure Importing Specifics
When you import a project from ReadMe to ClickHelp, the folders hierarchy in TOC is preserved, but the order of topics is not since the exported archive doesn't inlcude any infromation about the topics order. If needed, you can reorder the topics manually after the import.
Supported ReadMe Elements
| By "supported" elements, we mean ReadMe-specific elements. Common elements like paragraphs of text, links, images, etc., are not mentioned here since they are imported as they are. |
During the import, ClickHelp processes and converts the elements listed below to ClickHelp elements:
|
ReadMe element
|
ClickHelp element
|
Comment
|
|---|---|---|
|
Code blocks
|
Code Sample
|
|
|
Callouts
|
|
|
|
Embeds
|
—
|
Inserted as the <iframe> HTML tag.
|
| Page Description |
—
| Inserted as the <p> HTML tag with the description CSS class. The tag includes the content of the Description field of a ReadMe Page if it's not empty. |
|
Tabs
|
Tabs
|
|
Unsupported ReadMe Elements
Elements that are not currently supported are imported, keeping their HTML markup and content as much as possible. The element's specific functionality or some parts of content might be lost. But knowing its markup, you will be able to find its occurrences using the Global Find and Replace tool and correct them.
Importing API Reference
Currently, the automatic import of API definitions from ReadMe isn't supported since the exported archive doesn't include the Swagger/OpenAPI file or a link to it. The API reference is imported as standard topics. If the page in a ReadMe project includes some additional information added manually in the body, it is imported as well.
If you need to import your Swagger/OpenAPI definition file to ClickHelp, please refer to this article: Generate API Documentation.