Markdown export with Media/file export #3309

Open
opened 2026-02-05 06:19:22 +03:00 by OVERLORD · 11 comments
Owner

Originally created by @pitastrudl on GitHub (Oct 25, 2022).

Describe the feature you'd like

I've noticed that when you export a markdown file of a page, it includes URLs where the images are hosted, in some instances that can be Bookstack. I've searched for any existing issues but all I found was this: https://github.com/BookStackApp/BookStack/pull/2115

The markdown export would be exported as a zip/tar archive which could then be extracted into a folder or .md file + folder containing all the images.

Describe the benefits this would bring to existing BookStack users

Being able to export markdown files with images for offline use or sharing to other parties.

Can the goal of this request already be achieved via other means?

I have not tried it yet but my guess is that one could make it work with API:

  1. Download markdown file
  2. Download all files mentioned in the markdown file from bookstack into a folder
  3. Replace links in markdown file with the respective files

Have you searched for an existing open/closed issue?

  • I have searched for existing issues and none cover my fundemental request

How long have you been using BookStack?

0 to 6 months

Additional context

No response

Originally created by @pitastrudl on GitHub (Oct 25, 2022). ### Describe the feature you'd like I've noticed that when you export a markdown file of a page, it includes URLs where the images are hosted, in some instances that can be Bookstack. I've searched for any existing issues but all I found was this: https://github.com/BookStackApp/BookStack/pull/2115 The markdown export would be exported as a zip/tar archive which could then be extracted into a folder or .md file + folder containing all the images. ### Describe the benefits this would bring to existing BookStack users Being able to export markdown files with images for offline use or sharing to other parties. ### Can the goal of this request already be achieved via other means? I have not tried it yet but my guess is that one could make it work with API: 1. Download markdown file 2. Download all files mentioned in the markdown file from bookstack into a folder 3. Replace links in markdown file with the respective files ### Have you searched for an existing open/closed issue? - [x] I have searched for existing issues and none cover my fundemental request ### How long have you been using BookStack? 0 to 6 months ### Additional context _No response_
OVERLORD added the 🔨 Feature Request🚚 Export System labels 2026-02-05 06:19:22 +03:00
Author
Owner

@ssddanbrown commented on GitHub (Oct 25, 2022):

Somewhat related to #3182, different fundamental requests but a possible solution may look to meet both requests.

@ssddanbrown commented on GitHub (Oct 25, 2022): Somewhat related to #3182, different fundamental requests but a possible solution may look to meet both requests.
Author
Owner

@pitastrudl commented on GitHub (Oct 25, 2022):

Thanks @ssddanbrown. I was looking at the API docs but could not seem to find a way to list or get images of a page, I thought that was what the API for attachments was but that's a different function of bookstack?

@pitastrudl commented on GitHub (Oct 25, 2022): Thanks @ssddanbrown. I was looking at the API docs but could not seem to find a way to list or get images of a page, I thought that was what the API for attachments was but that's a different function of bookstack?
Author
Owner

@towerplease commented on GitHub (Feb 23, 2023):

An overall export-scheme would be nice, to export pages, chapters or shelves in a consistent file, with all media and hyperlinks. This could be imported to a Independent bookstack instance aswell.

@towerplease commented on GitHub (Feb 23, 2023): An overall export-scheme would be nice, to export pages, chapters or shelves in a consistent file, with all media and hyperlinks. This could be imported to a Independent bookstack instance aswell.
Author
Owner

@florian-obradovic commented on GitHub (Mar 4, 2023):

Would love to see this!

@florian-obradovic commented on GitHub (Mar 4, 2023): Would love to see this!
Author
Owner

@tenekev commented on GitHub (May 1, 2023):

I would love this. As someone who preps notes, diagrams, images in Bookstack, this would be the missing link between Bookstack and my SSG blog.

@tenekev commented on GitHub (May 1, 2023): I would love this. As someone who preps notes, diagrams, images in Bookstack, this would be the missing link between Bookstack and my SSG blog.
Author
Owner

@pchang388 commented on GitHub (Sep 3, 2023):

+1 on this feature, would like to have it as well. Awesome work on this regardless!

@pchang388 commented on GitHub (Sep 3, 2023): +1 on this feature, would like to have it as well. Awesome work on this regardless!
Author
Owner

@lazynooblet commented on GitHub (Nov 10, 2023):

An overall export-scheme would be nice, to export pages, chapters or shelves in a consistent file, with all media and hyperlinks. This could be imported to a Independent bookstack instance aswell.

This would be great. I'm doing some contract work on the side for similar tasks and am maintaining multiple instances of bookstack, one for each customer. At the moment I'm using copy/paste for text and images individually and its tedious at times.

@lazynooblet commented on GitHub (Nov 10, 2023): > An overall export-scheme would be nice, to export pages, chapters or shelves in a consistent file, with all media and hyperlinks. This could be imported to a Independent bookstack instance aswell. This would be great. I'm doing some contract work on the side for similar tasks and am maintaining multiple instances of bookstack, one for each customer. At the moment I'm using copy/paste for text and images individually and its tedious at times.
Author
Owner

@pchang388 commented on GitHub (Nov 28, 2023):

I've been working on something to do this for my own personal use but thought I would share - could be useful for some.

bookstack-file-exporter

So far I added the ability to:

  • Export pages in a parent-child layout (shelf/book/chapter/page)
  • Export images
  • For markdown files, replace image links/refs with exported image path. This allows you to render images in markdown previews with the exported local images.
  • Upload to Minio
@pchang388 commented on GitHub (Nov 28, 2023): I've been working on something to do this for my own personal use but thought I would share - could be useful for some. [bookstack-file-exporter](https://github.com/homeylab/bookstack-file-exporter) So far I added the ability to: - Export pages in a parent-child layout (shelf/book/chapter/page) - Export images - For markdown files, replace image links/refs with exported image path. This allows you to render images in markdown previews with the exported local images. - Upload to Minio
Author
Owner

@pchang388 commented on GitHub (Feb 14, 2024):

I've been working on something to do this for my own personal use but thought I would share - could be useful for some.

bookstack-file-exporter

So far I added the ability to:

  • Export pages in a parent-child layout (shelf/book/chapter/page)

  • Export images

  • For markdown files, replace image links/refs with exported image path. This allows you to render images in markdown previews with the exported local images.

  • Upload to Minio

I've added a newer version with some bug fixes and ability to handle/export attachments as well.

Hope it helps!

@pchang388 commented on GitHub (Feb 14, 2024): > I've been working on something to do this for my own personal use but thought I would share - could be useful for some. > > > > [bookstack-file-exporter](https://github.com/homeylab/bookstack-file-exporter) > > > > So far I added the ability to: > > - Export pages in a parent-child layout (shelf/book/chapter/page) > > - Export images > > - For markdown files, replace image links/refs with exported image path. This allows you to render images in markdown previews with the exported local images. > > - Upload to Minio I've added a newer version with some bug fixes and ability to handle/export attachments as well. Hope it helps!
Author
Owner

@sibitu commented on GitHub (May 16, 2024):

+1 for feature

@sibitu commented on GitHub (May 16, 2024): +1 for feature
Author
Owner

@patsch9 commented on GitHub (Jul 31, 2024):

+1

@patsch9 commented on GitHub (Jul 31, 2024): +1
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/BookStack#3309