Нет описания

Anchit Bajaj b5ae77a06b Add license 1 год назад
.github fc35210c02 Add goreleaser 1 год назад
bookstackclient 5af2729355 create summary.md 2 лет назад
cli 34b93bf4d8 Disable non-functional args and add instructions 1 год назад
config 3d57b253fb Bump up version 1 год назад
downloader 244fef93c8 Add generation date in README 1 год назад
.gitignore fc35210c02 Add goreleaser 1 год назад
.goreleaser.yaml fc35210c02 Add goreleaser 1 год назад
LICENSE b5ae77a06b Add license 1 год назад
Makefile 5af2729355 create summary.md 2 лет назад
README.md c4c2b790d9 Generate introduction page as well 1 год назад
example.env b0a1a95939 API calls in bookstack client to establish wiki structure 2 лет назад
go.mod 263501f494 Init 2 лет назад
go.sum 263501f494 Init 2 лет назад

README.md

BookStack2Site

CLI tool which generates static sites from Bookstack Wikis.

Usecases:

  • Sometimes you want a BookStack wiki for personal/team use and a public facing high traffic site for everyone else.
  • Offline backup of your wiki which is good looking and easy to navigate.
  • You want a markdown version of your wiki synced to a Git repo.

Screenshots

TODO

Usage

Increase the number of API requests allowed per minute in Bookstack by setting API_REQUESTS_PER_MIN=5000 in your Bookstack config.

One day I'll get time to add the automatically trigger SSG feature. Until then, this generates MdBook format markdown and you have to run the mdbook build command yourself.

If you just want markdown without an HTML site then don't run the mdbook command.

While setting up the first time:

mdboook init ./book-test

and edit the book.toml config to your liking.

Then every time you wanna download/update your wiki:

bookstack2site
    --bookstack-url=${BookStackEndpoint} \
    --token-id=${BookStackAPITokenID} \
    --token-secret=${BookStackAPITokenSecret} \
    --download-location="./book-test/src"

# to preview
cd ./book-test && mdbook serve -n 0.0.0.0

# to build
cd ./book-test && mdbook build

Thanks

  • The BookStack Project
  • MdBook