Skip to content

Imports a directory of markdown files to Bookstack

License

Notifications You must be signed in to change notification settings

showier-drastic/bookstack-import

 
 

Repository files navigation

bookstack-import

Imports a directory of markdown files to Bookstack

This was created to allow an automated migration from a folder of Markdown-Documents to BookStack. In our case the source-files were created by the excellent theohbrothers/ConvertOneNote2MarkDown from a OneNote notebook.

Running a migration

To run a migration the following environment variables are needed:

export BOOKSTACK_URL=http://127.0.0.1
export BOOKSTACK_TOKEN_ID=
export BOOKSTACK_TOKEN_SECRET=
export BOOKSTACK_IMPORT_PATH=./

./bookstack-import

Limitations

Since Bookstack is limited to four hierarchy levels (shelves, books, chapters and pages) a 1:1 migration is not possible. We decided not to import shelves and start at books for the import.

Source file Imported as
Introduction.md Book: Introduction
More/Test.md Chapter "Test" in Book "More"

About

Imports a directory of markdown files to Bookstack

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 98.4%
  • Shell 1.6%