README.md

OCR-PDF-Action

A GitHub action to turn scanned PDF's into searchable documents
Show your support!

Example and usage

Example of non-searchable PDF file turned into a searchable PDF file

How to use this action

Workflow Example(s) / Usage

View Example Workflow Usage

- uses: actions/checkout@v2
- uses: MarketingPipeline/OCR-PDF-Action@main
  with:
    # Define the input & output PDF file paths.
    input_file: .github/example_pdfs/Non-text-searchable.pdf
    output_file: .github/example_pdfs/output_searchable.pdf
    
- name: Commit and Push PDF File
  run: |
     git config --global user.name "github-actions[bot]"
     git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
     git add -A
     git commit -m "Added OCR PDF"
     git push

Example workflow file

Workflow Options:

Inputs	Meaning	Default	Required
input_file	The file path to the input PDF	undefined	Yes
output_file	The path to put the output PDF file	undefined	Yes

Note: The output folder MUST exist.

Contributing

Want to imrpove this action? Create a pull request with described in detail with your changes! If approved you will be added to the list of contributors of this awesome project!

See also the list of contributors who participate in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.