Docs Ahoy documentation

Export

On this page
  1. Export a library
  2. What's in the zip
  3. How long it stays

Any library can be exported, on every plan, published or not. Your documentation is never locked in.

Export a library

Owners and admins open the library's Settings and, under Export, press Export the library. Building the zip takes a moment; the section then shows Download the zip, with the number of pages and files and the size.

A library that is being filled by an import can't be exported until the import has finished.

What's in the zip

  • Every page as a Markdown file at its address, language first: en/billing/invoices.md. Hidden pages are included; the trash is not.
  • The images and files those pages use, as their originals, in assets/. A dark version sits next to its light one, in a dark folder.
  • A README.md at the root that explains what's inside and lists any warnings, such as a file that wasn't ready.
  • A SUMMARY.md per language, in sidebar order, the way GitBook lays out a repository: the export can be imported again, here or elsewhere.
  • Page settings (description, icon, cover) as front matter at the top of the pages that have them.
  • Links between pages as relative .md links, and images as relative paths, so the files work outside Docs Ahoy.

How long it stays

One export is kept per library: a new export replaces the previous one. An export is deleted after 7 days; export again whenever you need a fresh one.