coolharsh55 / pdf2slideshow

Creates a Reveal.js HTML slideshow from a PDF document

pdf2slideshow

Creates a Reveal.js HTML slideshow from a PDF document

For more info, see blog post

requirements

• pdftoppm - extracts PDF pages as images ; usually packed as part of poppler or poppler-utils on your distro
• pngquant - compresses PNG ; available in package managers
• sed - text manipulation with files
• tree - optionally required if index is to be generated

How to use

1. To convert a single PDF to HTML slideshow, script.sh -p PDF
2. To convert a bunch of folders with a PDF, script_batch.sh -p FOLDER
3. Parameters:

• -p PATH: Path to PDF or folder
• -f: Force re-processing. Otherwise it will skip folders with index.html
• -i: For script_batch.sh generates an index.html in root folder using tree

PDF -> HTML

1. script.sh does all of the work
2. To edit the final reveal.js template, customise template.html
3. You might need to configure location of reveal.js in the template, the default is set to work for example in this repo
4. You use it as script.sh PDF_Path Output_path
5. It will extract PNG in output folder, copy template as index.html, and insert links to each image in the HTML
6. See demo at https://harshp.com/pdf2slideshow/example

So given a PDF and a PATH, the output will be:

PATH
  |-- PDF
  |-- index.html + pngs

Folders with PDFs -> HTML

If you have a nested folder structure with each PDF being in its own folder, then the script script_batch.sh can process the entire folder and generate HTML in each folder.

So given an input folder such as:

root
  |-- folderA
      |-- PDF
  |-- folderB
      |-- PDF    

The output will be:

root
  |-- index.html (if -i parameter is passed)
  |-- folderA
      |-- PDF
      |-- index.html + pngs
  |-- folderB
      |-- PDF 
      |-- index.html + pngs   

Testing & Development

• ShellCheck as bash linter
• tested and confirmed over presentations output

License

MIT, see License file for full text