actions-marketplace-validations/Gitbook Action
Github Action For Gitbook
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| token | Can be Token or Password for source_repo(clone token) and publish_repo(clone push token) | yes | — |
| git_name | Default GITHUB_ACTOR, If git name is different with github, please add | no | — |
| git_email | Default **@users.noreply.github.com If git name is different with github, please add | no | — |
| time_zone | System Default, if set, like Asia/Shanghai | no | — |
| source_token | Default token, if not, please add (clone) | no | — |
| source_git_name | Default git_name, if not, please add | no | — |
| source_repo | Default this GITHUB_REPOSITORY, if not please add like username/reponame | no | — |
| source_hub | default is github.com,can be gitlib.com gitee.com ... | no | github.com |
| source_branch | Default master | no | master |
| source_dir | Where gitbook source. Default is root | no | / |
| source_edit_time | Default false, if plugins need last edit time, set true | no | false |
| source_file_without_prefix | Default true, if you want to ignore file without prefix please set false | yes | true |
| publish_token | Default token, if not please add (clone push) | no | — |
| publish_git_name | Default git_name, if not please add | no | — |
| publish_git_email | Default git_email, if not please add | no | — |
| publish_repo | Default this GITHUB_REPOSITORY, if not please add like username/reponame | no | — |
| publish_commit_message | Default Updated by gitbook-action and time, can use last commit message | no | — |
| publish_hub | Default is github.com,can be gitlib.com gitee.com ... | no | github.com |
| publish_branch | Defaule is gh-pages, auto create | no | gh-pages |
| publish_dir | Default is root, if not add like docs or docs/gitbook ... | no | / |
| publish_commit_history | set false will only one commit at publish_repo | no | true |
| publish_cname | Default null, can set www.example.com example.com ... | no | null |
| publish_nojekyll | Default false, if set true, it will add .nojekyll for publish | no | false |
| publish_push_force | Default false. Set true will enable git push force | no | false |
| publish_remove_last_build | Default true. Set false not remove last build but rewrite same file | no | true |
| gitbook_cli_version | Default is 2.3.2, can choose from https://www.npmjs.com/package/gitbook-cli?activeTab=versions | no | — |
| gitbook_version | Default is 3.2.3, can choose from https://www.npmjs.com/package/gitbook?activeTab=versions | no | — |
| gitbook_pdf | Set true will generate pdf file | no | false |
| gitbook_pdf_dir | Where the pdf to put. Default mybook, can change / for root, or myebook | no | mybook |
| gitbook_pdf_name | The name of your pdf. Default ebook | no | ebook |
| gitbook_epub | Set true will generate epub file | no | false |
| gitbook_epub_dir | — | no | mybook |
| gitbook_epub_name | — | no | ebook |
| gitbook_mobi | Set true will generate mobi file | no | false |
| gitbook_mobi_dir | — | no | mybook |
| gitbook_mobi_name | — | no | ebook |
| source2_git_name | Default git_name, if not please add | no | — |
| source2_token | Default token, if not please add (clone) | — | — |
| source2_hub | — | no | github.com |
| source2_repo | Default null, if use please add like username/reponame, (same with source will replace, different will mix) | no | null |
| source2_branch | — | no | master |
| source2_dir | — | no | / |
| source2_edit_time | Default false if plugins need last edit time, set true | no | false |
| source2_file_without_prefix | Default true, if you want to ignore file without prefix please set false | yes | true |
| publish2_git_name | Default git_name, if not please add | no | — |
| publish2_token | Default token, if not please add (clone push) | — | — |
| publish2_git_email | Default git_email, if not please add | no | — |
| publish2_commit_message | Default Updated by gitbook-action and time | no | — |
| publish2_hub | — | no | github.com |
| publish2_repo | Default null, if use please add like username/reponame | no | null |
| publish2_branch | Default gh-pages | no | gh-pages |
| publish2_nojekyll | Default false, if set true, it will add .nojekyll for publish2 | no | false |
| publish2_dir | — | no | / |
| publish2_cname | Default null | no | null |
| publish2_push_force | Default false. Set true will enable git push force | no | false |
| publish2_commit_history | set false will only one commit at publish2_repo | no | true |
| publish2_remove_last_build | Default true. Set false not remove last build but rewrite same file | no | true |
| publish3_git_name | Default git_name, if not please add | no | — |
| publish3_token | Default token, if not please add (clone push) | — | — |
| publish3_git_email | Default git_email, if not please add | no | — |
| publish3_commit_message | Default Updated by gitbook-action and time | no | — |
| publish3_hub | — | no | github.com |
| publish3_repo | Default null, if use please add like username/reponame | no | null |
| publish3_branch | Default gh-pages | no | gh-pages |
| publish3_dir | Default root | no | / |
| publish3_cname | Default null | no | null |
| publish3_nojekyll | Default false, if set true, it will add .nojekyll for publish3 | no | false |
| publish3_push_force | Default false. Set true will enable git push force | no | false |
| publish3_commit_history | set false will only one commit at publish3_repo | no | true |
| publish3_remove_last_build | Default true. Set false not remove last build but rewrite same file | no | true |
| not_clean | Default false. Set true will not remove working file | no | false |
| font_install | Install font for pdf | no | — |
| prepare_install | Some install for prepare | no | — |
Outputs
no outputs