s-waite/pdf-to-img

A small script to convert PDF files to high-quality PNG or JPG images

PDF to Image

A shell script to convert PDFs into high quality images

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

(back to top)

Built With

• Zsh

(back to top)

Getting Started

Since this is a shell script you can either run it with a absolute path, or copy/link it to you PATH

Installation

1. Clone the repo

   git clone https://github.com/s-waite/pdf-to-img.git

2. cd the repo folder and run the script

   ./pdf-to-img.zsh

3. Move the script to your path if you want to be able to run it with 'pdftoimg' from anywhere

   mv /.pdf-to-img /usr/local/bin/pdftoimg

(back to top)

Usage

Three flags are provided:

• -c: colorspace, can either be grayscale or color
• -w: width of output in px
• -f: image output filetype, can be png or jpg

(back to top)

Roadmap

• [] Feature 1
• [] Feature 2
• [] Feature 3
  • [] Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)