{"id":24840483,"url":"https://github.com/tuliren/publish-gitbook","last_synced_at":"2025-08-20T20:22:48.166Z","repository":{"id":65155756,"uuid":"235264508","full_name":"tuliren/publish-gitbook","owner":"tuliren","description":"Github action to publish gitbook to github pages https://tuliren.dev/publish-gitbook","archived":false,"fork":false,"pushed_at":"2022-10-19T03:23:46.000Z","size":654,"stargazers_count":18,"open_issues_count":0,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-01-01T06:00:17.756Z","etag":null,"topics":["deploy","gitbook","github-action","github-page","publish"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/publish-gitbook","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tuliren.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-01-21T05:39:38.000Z","updated_at":"2024-04-17T12:49:42.000Z","dependencies_parsed_at":"2023-01-05T05:02:55.389Z","dependency_job_id":null,"html_url":"https://github.com/tuliren/publish-gitbook","commit_stats":{"total_commits":31,"total_committers":3,"mean_commits":"10.333333333333334","dds":0.09677419354838712,"last_synced_commit":"501146966c594d117ccc5479f63f2abfca264978"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tuliren%2Fpublish-gitbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tuliren%2Fpublish-gitbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tuliren%2Fpublish-gitbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tuliren%2Fpublish-gitbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tuliren","download_url":"https://codeload.github.com/tuliren/publish-gitbook/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":236476277,"owners_count":19154816,"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":["deploy","gitbook","github-action","github-page","publish"],"created_at":"2025-01-31T06:57:29.346Z","updated_at":"2025-01-31T06:57:29.785Z","avatar_url":"https://github.com/tuliren.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gitbook Publish Action\n\n[![Build Status](https://img.shields.io/github/workflow/status/tuliren/publish-gitbook/build?style=for-the-badge)](https://github.com/tuliren/publish-gitbook/actions/workflows/build.yml) [![GitHub Marketplace](https://img.shields.io/badge/github%20marketplace-publish%20gitbook-blue?style=for-the-badge)](https://github.com/marketplace/actions/publish-gitbook)\n\nThis action publishes a gitbook to github pages.\n\nThe source branch is `master`, and the target branch is `gh-pages`. If `gh-pages` does not exist, it will be created automatically.\n\n## How to Use\n\n```yml\njobs:\n  build:\n    name: Build Gitbook\n    runs-on: ubuntu-latest\n    steps:\n      # Check out the repo first\n      - name: Checkout code\n        uses: actions/checkout@v2\n      # Run this action to publish gitbook\n      - name: Publish\n        uses: tuliren/publish-gitbook@v1.0.1\n        with:\n          # specify either github_token or personal_token\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n          # personal_token: ${{ secrets.PERSONAL_TOKEN }}\n```\n\nPlease note that either `personal_token` or `github_token` needs to be specified.\n\n### `github_token` (recommended)\n\nIf you choose `github_token`, this token is auto created when workflow launches. No extra operation is needed.\n\n### `personal_token`\n\n- Create a Personal Access Token ([instruction](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line#creating-a-token)).\n- Add the token as a repo secret ([instruction](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets#creating-encrypted-secrets)).\n  - Secret name: `PERSONAL_TOKEN`\n  - Secret value: `\u003ctoken\u003e`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftuliren%2Fpublish-gitbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftuliren%2Fpublish-gitbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftuliren%2Fpublish-gitbook/lists"}