{"id":20971752,"url":"https://github.com/icewreck/bookstack2site","last_synced_at":"2025-03-13T08:20:59.736Z","repository":{"id":65811844,"uuid":"543773282","full_name":"IceWreck/BookStack2Site","owner":"IceWreck","description":"CLI tool which generates static sites from Bookstack Wikis.","archived":false,"fork":false,"pushed_at":"2023-11-14T03:03:39.000Z","size":21,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-08T18:04:49.616Z","etag":null,"topics":["bookstack","bookstack-to-git","wiki"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IceWreck.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-09-30T20:11:47.000Z","updated_at":"2024-03-06T03:10:58.000Z","dependencies_parsed_at":"2023-11-13T19:58:43.888Z","dependency_job_id":"59d9b9d3-91c4-41fd-9218-192e1ab2559c","html_url":"https://github.com/IceWreck/BookStack2Site","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IceWreck%2FBookStack2Site","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IceWreck%2FBookStack2Site/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IceWreck%2FBookStack2Site/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IceWreck%2FBookStack2Site/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IceWreck","download_url":"https://codeload.github.com/IceWreck/BookStack2Site/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243366542,"owners_count":20279377,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bookstack","bookstack-to-git","wiki"],"created_at":"2024-11-19T04:05:02.775Z","updated_at":"2025-03-13T08:20:58.985Z","avatar_url":"https://github.com/IceWreck.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BookStack2Site\n\nCLI tool which generates static sites from Bookstack Wikis.\n\n**Usecases:**\n\n- Sometimes you want a BookStack wiki for personal/team use and a public facing high traffic site for everyone else.\n- Offline backup of your wiki which is good looking and easy to navigate.\n- You want a markdown version of your wiki synced to a Git repo.\n\n## Screenshots\n\nTODO\n\n## Usage\n\nIncrease the number of API requests allowed per minute in Bookstack by setting `API_REQUESTS_PER_MIN=5000` in your Bookstack config.\n\nOne 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.\n\nIf you just want markdown without an HTML site then don't run the `mdbook` command.\n\nWhile setting up the first time:\n\n```bash\nmdboook init ./book-test\n```\n\nand edit the `book.toml` config to your liking.\n\nThen every time you wanna download/update your wiki:\n\n```bash\nbookstack2site\n    --bookstack-url=${BookStackEndpoint} \\\n    --token-id=${BookStackAPITokenID} \\\n    --token-secret=${BookStackAPITokenSecret} \\\n    --download-location=\"./book-test/src\"\n\n# to preview\ncd ./book-test \u0026\u0026 mdbook serve -n 0.0.0.0\n\n# to build\ncd ./book-test \u0026\u0026 mdbook build\n```\n\n## Thanks\n\n- The BookStack Project\n- MdBook\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficewreck%2Fbookstack2site","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ficewreck%2Fbookstack2site","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficewreck%2Fbookstack2site/lists"}