Importing Documentation

DeveloperHub provides powerful tools to enable you to easily move your content around, edit it and restructure it, all out of the editor.

Import Sources

You can import to DeveloperHub from many sources:

• Markdoc export (available for entire project imports and one page imports)

• Markdown

• ReadMe

• Zendesk

• Other sources, such as: HTML, Confluence, Word or other external sources.

Import a Markdoc Export

To import documentation, follow these steps:

• Make sure your import files are structured as required.

• Open Project Settings → Import & Export.

• Click Open import.

• Choose Markdoc.

Importing could take a few seconds up to a minute.

Import a page into DeveloperHub

You can import a single Markdown or a Markdoc page at a time into DeveloperHub.

To import one page, follow these steps:

• From the index, choose the page to import over, or create a new page and save it.

• Under the title, click on Import icon
  

• Choose the file to be imported.

Structuring Files

To import documentation from DeveloperHub export into DeveloperHub, you must structure your files as such:

Where, for example:

• v1.0 is the name of your version.

• Support Center is the title of your documentation.

• 1 Getting Started.md is a documentation page written in Markdoc format. Its order is 1st in Support Center documentation and its title is Getting Started. Getting Started folder indicates that 1 Getting Started.md is a parent page, and it has a subpage titled First Steps.

• 1 Formatting Text.md, 2 Keyboard Shortcuts.md and 3 Using Markdown.md are all subpages of Writing Documentation page.

• settings.json is Support Center documentation settings file. Settings file is an optional file.

Every parent page should have a a Markdown file and a folder with the same exact name.

The orders must be incremental and starting from 1. If an order is not supplied in the file name, then no index order is guaranteed.

Additionally, you may add OpenAPI spec files in a folder named refs in the version folder.

All the files in the import must be compressed into a ZIP file.

File Format

Each file contains a YAML header (frontmatter) and, for pages, optional content.

Header

Each file contains a header depending on the index element being described.

• Page:

• Category:

• Link:

• Separator:

Content

Category, link and separator elements do not have content. Pages do have content, written in Markdoc: plain Markdown mixed with DeveloperHub's block tags.

Draft and published page contents can be defined in an export and it is annotated by a ---draft or ---published header, such as:

Blocks

Blocks and inline blocks are written in Markdoc tag syntax. See Markdoc Format for the full syntax of every block, with an example for each.

Feel free to export any page to understand the formatting of its contents.

Image Import

If an image is referenced in Markdown format in one of the pages, it will automatically be downloaded to our servers and served from our content delivery network.

Images can be uploaded from two sources:

• HTTP, or

• Local

Regardless of the image source, each image must be at maximum 10MB in size. Otherwise, the import will fail.

HTTP Image Import

To import images from the internet, they should be referenced as such:

It will then be downloaded from its source, and uploaded to our content delivery network. The image must be accessible online publicly, otherwise the import will fail.

Local Image Import

To import images locally from the provided ZIP file, they must exist in a folder named assets alongside the versions.

They should be referenced as such:

Inside assets folder, any folder structure is allowed.