Skip to content

Content Sync Workflow Between BookStack and Local Repos #6079

@kugarocks

Description

@kugarocks

Describe the feature you'd like

I would like BookStack to support an official workflow for syncing content between a BookStack instance and a local repository.

The basic flow would be:

  1. Pull content from BookStack to local files.
  2. Edit and manage the content locally.
  3. Push local changes back to BookStack.

I’ve built a demo version, but it has problems with more complex sync scenarios.

Image

Describe the benefits this would bring to existing BookStack users

This would make it much easier to manage BookStack content with Git, local editors (Neovim), scripts, and CI workflows. It would also help with large-scale content updates, review/rollback workflows, and migration use cases.

Another important benefit is AI tooling. If BookStack content can be represented reliably as local files, it becomes much easier to use AI tools for rewriting, summarization, translation, restructuring, and bulk content improvements. These workflows are much harder to do efficiently in a web-only interface.

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

Partially. Some parts of this can already be achieved through the API or exports, but there is still no official and reliable pull/edit/push workflow. An officially supported solution would be much more practical for teams managing documentation as code.

Have you searched for an existing open/closed issue?

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

How long have you been using BookStack?

2 years.

Additional context

Even a limited first version would already be valuable, such as:

  • Pulling content into a structured local format
  • Pushing local changes back
  • Supporting the most common content structures first

Thanks for considering this feature request.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions