BookStack Code Mirror - website/blob - content/docs/user/export-import.md

   1 +++
   2 title = "Exporting & Importing Content"
   3 date = "2024-12-20"
   4 type = "user-doc"
   5 +++
   6
   7 BookStack allows its content to be exported in a range of formats, while also providing
   8 a few options for importing content.
   9 Note that these option are not intended for backup or restore, for which you [can find relevant documentation here](/docs/admin/backup-restore/).
  10
  11 ### Exporting
  12
  13 Within BookStack, if you have the required "Export content" role permission, you can export books,
  14 chapters or pages in the following formats:
  15
  16 - Contained Web File
  17   - A ".html" file with images embedded where possible, which can be opened in a browser.
  18   - This usually provides the best representation of your BookStack content.
  19 - PDF File
  20   - A ".pdf" document file representation of your content.
  21   - The output of this can sometimes be inaccurate or lack certain features compared to how its represented in BookStack.
  22 - Plain Text File
  23   - A ".txt" file with just the text containing in your content.
  24 - Markdown File
  25   - A ".md" file with a markdown representation of your content.
  26   - If the page was written using the Markdown editor, then that original content will be provided otherwise this export will attempt a conversion to Markdown.
  27   - The resulting markdown may still use HTML for some content types.
  28 - Portable ZIP
  29   - A ".zip" containing data, attachment and image files.
  30   - This can be re-imported to BookStack instances as mentioned below.
  31   - The exact format can be found documented [in the BookStack source here](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/portable-zip-file-format.md).
  32
  33 Although not shown as an export format, care is taken in BookStack to ensure that pages display well via browser printing options.
  34 This allows you to print to paper, or often to PDF, via your browser's print action as another form of export.
  35
  36 For developers, many of these export options can also be accessed over the [BookStack REST API](/docs/admin/hacking-bookstack/#bookstack-api), which
  37 also provides many other endpoints that may be found useful for export-focused tasks.
  38
  39 ### Importing
  40
  41 Within BookStack, if you have the required "Import content" role permission, you can import "Portable ZIP"
  42 files (as mentioned in the [exporting](#exporting) section above) via the "Import" action seen when viewing the
  43 top-level "Books" view, or by going to the `/import` URL path of your instance:
  44
  45 <img src="/images/docs/user/import-overview.png" alt='View of the import page, with a field to select a ZIP for upload, and a section below showing "Pending Imports" with one "IT Department" book listed' width="600">
  46
  47 Here you'll be able to upload a new ZIP file for import, or continue a previously uploaded pending import.
  48 Before the import runs, you'll be provided a preview of what's due to be imported.
  49 When ran, the content will be imported into BookStack, and the original uploaded ZIP file will be deleted.
  50
  51 For developers, the details of this importable ZIP format [can be found here](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/portable-zip-file-format.md) otherwise you could also consider the [BookStack REST API](/docs/admin/hacking-bookstack/#bookstack-api) as an option for import.