GitHub Action for converting ebooks in several formats. The action is based on Calibre's converting function ebook-convert
. For more information about the supported formats, available options and practical hints, please refer to the documentation. The GitHub action sets up a Docker image with Calibre installed in which the document gets converted.
The action supports conversions between many file types i.e.:
DOCX, EPUB, HTML, PDF, RTF, TXT...
For the full list see the documentation.
In order to use the action, it must be integrated to the workflow:
- uses: jensvog/ebook-convert-action@v1
with:
in: <in-file>
out: <out-file>
args: <arguments>
Parameter | Information |
---|---|
in | File to be converted, i.e. your-pdf.pdf or book/your-pdf.pdf . Relative to your repository. |
out | Output file, i.e. your-epub.epub . It can also contain path information book/your-epub.epub . If the directory does not exist, it will be created. |
args | (optional) Additional arguments according to documentation |
The output file format is guessed based on the output file extension.
This example takes a PDF document from a repository and converts it to an EPUB file. Afterwards this file is stored as an artifact.
name: EBook conversion
on: [push]
jobs:
convert:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Convert ebook
uses: jensvog/ebook-convert-action@v1
with:
in: book.pdf
out: book.epub
- name: Upload
uses: actions/upload-artifact@master
with:
name: Book
path: book.epub
MIT: See LICENSE
for detailed license information.