bookstack-import

command module
v0.0.0-...-61b6198 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 1, 2024 License: MIT Imports: 13 Imported by: 0

README

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"

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL