{"id":20944668,"url":"https://github.com/lazybytez/sync-markdown-bookstack-action","last_synced_at":"2026-04-12T11:39:36.684Z","repository":{"id":196164482,"uuid":"694792817","full_name":"lazybytez/sync-markdown-bookstack-action","owner":"lazybytez","description":"Sync some markdown files from your repository with BookStack","archived":false,"fork":false,"pushed_at":"2023-09-24T16:55:03.000Z","size":351,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-01-19T21:39:20.218Z","etag":null,"topics":["actions","bookstack","markdown"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/lazybytez.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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-21T17:48:17.000Z","updated_at":"2024-03-24T13:27:37.000Z","dependencies_parsed_at":"2023-09-22T03:32:10.878Z","dependency_job_id":"74a22497-45c6-4c61-a763-873ac6e1b931","html_url":"https://github.com/lazybytez/sync-markdown-bookstack-action","commit_stats":null,"previous_names":["lazybytez/sync-markdown-bookstack-action"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lazybytez%2Fsync-markdown-bookstack-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lazybytez%2Fsync-markdown-bookstack-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lazybytez%2Fsync-markdown-bookstack-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lazybytez%2Fsync-markdown-bookstack-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lazybytez","download_url":"https://codeload.github.com/lazybytez/sync-markdown-bookstack-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243335418,"owners_count":20274904,"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":["actions","bookstack","markdown"],"created_at":"2024-11-18T23:44:42.052Z","updated_at":"2025-12-29T11:25:13.511Z","avatar_url":"https://github.com/lazybytez.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sync Markdown to BookStack Action\n\n[![gh-commit-badge][gh-commit-badge]][gh-commit]\n[![gh-contributors-badge][gh-contributors-badge]][gh-contributors]\n[![gh-stars-badge][gh-stars-badge]][gh-stars]\n\n## Description\nThis action allows to synchronize one or more Markdown files to BookStack.\nThis makes it possible to maintain documentation within a repository while still\nmaking it available in your central documentation solution.\n\nThis action features:\n- Sync to either a chapter or a book\n- Use either a single file or a glob pattern to sync multiple files\n- Keep your pages up to date - the action can create and update pages\n\n## Limitations\n- To support globs and therefore the creation of multiple pages at once, this action uses the **first** headline of type **# (h1)** as the name for the pages\n- Your Markdown files **must** have at least one **#** to be accepted by the Action\n- The sync is currently one way, so deleting files from the repository won't delete the pages from BookStack\n- We always push an update to BookStack which generates additional traffic, however, BookStack won't create additional revisions if the content is unchanged\n- You must grab the book/chapter ID from the database or using the API to configure the action\n\n## Inputs\n\n### `url`\n- **Required**\n- The URL to your BookStack instance, where the files will be synced to.\n\n### `token-id`\n- **Required**\n- The ID of your BookStack API connection.\n\n### `token-secret`\n- **Required**\n- The secret of your BookStack API connection.\n\n### `book-id`\n- **Required, when `chapter-id` is not set**\n- The ID of the book to sync to.\n\n### `chapter-id`\n- **Required, when `book-id` is not set**\n- The ID of the book to sync to.\n\n### `path`\n- The path to the Markdown file(s) to sync, you can use glob patterns for multiple files\n\n## Outputs\nThis action does not output anything, if everything goes well.\n\n## Example usage\n\n```yaml\nuses: lazybytez/sync-markdown-bookstack-action@1.0.0\nwith:\n    bookstack-url: 'https://bookstack.your.url'\n    bookstack-token-id: '{{ secrets.BOOKSTACK_TOKEN_ID }}'\n    bookstack-token-secret: '{{ secrets.BOOKSTACK_TOKEN_SECRET }}'\n    # You only need one of book-id or chapter-id\n    book-id: 123\n    chapter-id: 123\n    # You can either use a path to a file or a glob pattern:\n    path: 'sub/directories/README.md'\n    path: 'sub/*/*.md'\n```\n\n## Development\nTo develop locally, you should install **NodeJS 20**.\n\nThe following commands can be used for local development:\n```shell\n# Install dependencies\n$ npm install\n\n# Format and bundle for distribution\n$ npm run bundle\n\n# Only check code style using prettier\n$ npm run format:check\n\n# Check code style and reformat\n$ npm run format:write\n```\n\nBe sure to always run the bundler and commit the `dist/` directory when doing changes to the code.\n\n## Contributing\n\nIf you want to take part in contribution, like fixing issues and contributing directly to the codebase, please visit\nthe [How to Contribute][gh-contribute] document.\n\n## Useful links\n\n[License][gh-license] -\n[Contributing][gh-contribute] -\n[Code of conduct][gh-codeofconduct] -\n[Issues][gh-issues] -\n[Pull requests][gh-pulls]\n\n\u003chr\u003e  \n\nCopyright (c) [Lazy Bytez][gh-team]. All rights reserved | Licensed under the MIT license.\n\n\u003c!-- Variables --\u003e\n\n[gh-commit-badge]: https://img.shields.io/github/last-commit/lazybytez/sync-markdown-bookstack-action?style=for-the-badge\u0026colorA=302D41\u0026colorB=cba6f7\n\n[gh-commit]: https://github.com/lazybytez/sync-markdown-bookstack-action/commits/main\n\n[gh-contributors-badge]: https://img.shields.io/github/contributors/lazybytez/sync-markdown-bookstack-action?style=for-the-badge\u0026colorA=302D41\u0026colorB=89dceb\n\n[gh-contributors]: https://github.com/lazybytez/sync-markdown-bookstack-action/graphs/contributors\n\n[gh-stars-badge]: https://img.shields.io/github/stars/lazybytez/sync-markdown-bookstack-action?style=for-the-badge\u0026colorA=302D41\u0026colorB=f9e2af\n\n[gh-stars]: https://github.com/lazybytez/sync-markdown-bookstack-action/stargazers\n\n[gh-contribute]: https://github.com/lazybytez/.github/blob/main/docs/CONTRIBUTING.md\n\n[gh-license]: https://github.com/lazybytez/sync-markdown-bookstack-action/blob/main/LICENSE\n\n[gh-codeofconduct]: https://github.com/lazybytez/.github/blob/main/docs/CODE_OF_CONDUCT.md\n\n[gh-issues]: https://github.com/lazybytez/sync-markdown-bookstack-action/issues\n\n[gh-pulls]: https://github.com/lazybytez/sync-markdown-bookstack-action/pulls\n\n[gh-team]: https://github.com/lazybytez\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flazybytez%2Fsync-markdown-bookstack-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flazybytez%2Fsync-markdown-bookstack-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flazybytez%2Fsync-markdown-bookstack-action/lists"}