manoelcampos/asciidoctor-ghpages
Build AsciiDoc GitHub Pages: renames resulting README.html to index.html. Generates an ebook.pdf or Reveal.js slides
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| source_dir | Defines the source root directory from where AsciiDoc files will be built and other containing files will be published to gh-pages. | no | . |
| asciidoctor_params | Extra parameters to pass to the asciidoctor command to customize the process of building adoc files | no | — |
| adoc_file_ext | The extension you are using for your AsciiDoc Files | no | .adoc |
| pdf_build | Defines if a PDF ebook should be built along with the html files. That will generate an ebook.pdf file inside the gh-pages branch. | no | false |
| ebook_main_adoc_file | Defines the name of the main AsciiDoc file that will be used if you are generating an ebook in PDF or any other supported format. For instance, if the main ebook file is "ebook.adoc", just inform "ebook" here. | no | README |
| slides_build | Defines if a slides.html file should be built using AsciiDoc Reveal.js. The slides.html file is generated inside the gh-pages branch. | no | false |
| slides_main_adoc_file | Defines the name of the main AsciiDoc file that will be used if you are generating slides with Reveal.js. For instance, if the slides file is "slides.adoc", just inform "slides" here. | no | README |
| slides_skip_asciidoctor_build | If slides are being generated using AsciiDoc Reveal.js, you may not want to build the regular html files using the asciidoctor command, but just using the asciidoctor-revealjs command. In order to generate only the slides.html instead of the regular html files, set this config to true. | no | false |
| pre_build | Any arbitrary shell command to be executed before the asciidoc build is started. Optional. | no | echo "No pre build command provided." |
| post_build | Any arbitrary shell command to be executed after the asciidoc build is complete and before committing changes on gh-pages branch. Optional. | no | echo "No post build command provided." |
Outputs
no outputs