Export Markdown Data

ReadMe allows you to export docs into Markdown files.

πŸ“˜

Exports are not complete.

Some information is lost during the exporting process. For example, instead of downloading images, the exported files contain URL references to images stored in ReadMe. Things such as the order of the categories, pages will also be lost within the export process.

In addition, if you try to re-import exported API Reference Markdown pages, they will be imported as Guides Markdown pages. For this scenario, you can easily move content between sections.

To export your docs, click on Configuration > Project Settings, then scroll to the bottom to Project Management and Export Docs.

Exporting a project includes all versions by default. After unzipping the export, you'll see a list of versions. You should see all categories which will contain the Markdown pages created either in your Guides or API Reference section:

To separate the versions, unzip the file and zip up versions individually.

πŸ“˜

Exporting project data includes everything except:

  1. API Endpoints (API Definitions file / Manual API entries)
  2. Custom pages
  3. Discussions

Any content in the API Definitions / API Settings will not be exported, as that is separate from the Markdown content.


What’s Next
Did this page help you?