https://github.com/icewreck/bookstack2site

CLI tool which generates static sites from Bookstack Wikis.
https://github.com/icewreck/bookstack2site

bookstack bookstack-to-git wiki

Last synced: 1 day ago
JSON representation

CLI tool which generates static sites from Bookstack Wikis.

• Host: GitHub
• URL: https://github.com/icewreck/bookstack2site
• Owner: IceWreck
• License: mit
• Created: 2022-09-30T20:11:47.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-11-14T03:03:39.000Z (about 1 year ago)
• Last Synced: 2025-01-15T06:06:56.675Z (6 days ago)
• Topics: bookstack, bookstack-to-git, wiki
• Language: Go
• Homepage:
• Size: 20.5 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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:

```bash

mdboook init ./book-test

```

and edit the `book.toml` config to your liking.

Then every time you wanna download/update your wiki:

```bash

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