Exporting Documentation

Your data is your data. You can always export it at any time.

We provide project exports in two formats:

  • Darkdown: Use if you wish to re-import the data into DeveloperHub later with no data loss.
  • Markdown: Use for external purposes.

Darkdown

Darkdown is our flavour of Markdown. When a project is exported, and imported back, Darkdown allows the following to be retained:

  • All the published and draft text in each page.
  • All the blocks in each page with every configuration and detail.
  • The order of the pages.
  • Categories and external links.
  • Documentation settings.

Exporting a Project

To export a project:

  • Open Project Settings from the sidebar.
  • Click Export .
  • Choose the export format. The active project will be exported.

It will take a few seconds, and a download will start. The downloaded file is a compressed file (zip) containing all versions, documentations, API references, and indices of the documentation. The structure of the file is as such:

To learn how to import this export back into DeveloperHub, check Importing Documentation.

Exporting a Page

To export a page:

  • In the documentation index, select the page to be exported.
  • Click on Export under the title.

The export will be in DeveloperHub Darkdown format.

Exporting Images

To export the images you have in your DeveloperHub project, follow these steps:

  • Get a markdown export of your project first.
  • Unzip the export.
  • Use our tool mdimg which finds all the URLs in the export and downloads the images. You can find already built binaries for linux and mac in the releases.
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
  Last updated by Zaid Daba'een