Migrate from other platforms
Migrate any live documentation site, a folder of Markdown, MDX, or HTML files, or a MadCap Flare site to Documentation.AI.
If your platform does not have its own page, you can still migrate from its live site or from a folder of files. The steps are the same as for every platform. See Overview.
What you can migrate from
- Any live documentation site, such as
https://docs.acme.com. The migrator finds pages through the site's sitemap, its sidebar, and the links between pages. - A folder of Markdown, MDX, or HTML files, such as a repository you cloned. Tell your assistant where it is.
- A MadCap Flare site that you publish as HTML.
- A MadCap Flare project, as the project folder itself. The migrator reads your sidebar from the project's table of contents files. If the project has several and nothing names which to use, or an entry that a target both includes and excludes, your assistant asks you at the first decision rather than guessing.
How the structure is read
- On a live site, the sidebar order is used where the site shows one. Otherwise the order comes from the sitemap.
- In a folder of files, the structure comes from the folders. You review it at the first decision.
- On a MadCap Flare site, the table of contents is read from the files the site publishes with it. If the site publishes more than one help system, you choose one at the first decision. Migrate each other help system separately.
What moves
| On your old site | In Documentation.AI |
|---|---|
| Pages | Pages, word for word |
Expandable details sections and MadCap drop-downs | Expandable |
| Admonitions, such as notes and warnings | Callout |
| Cards | Card and Columns |
| MadCap tile grids | Cards in columns |
| MadCap linked tables of contents | Lists of links |
| Embedded frames and videos | Embedded frames and Video |
| Images and files | Files in your media library |
What needs your decision
- Other components, such as custom HTML widgets. At the second decision, your assistant shows each kind with the pages that use it.
- Pages the sidebar does not list. At the first decision, you choose whether to add them.
What does not move
- Scripts and styles from your old pages. Documentation.AI pages do not run page scripts.
- Your footer, custom fonts, and banner. See What does not move.
Related
Was this page helpful?