pdf-gold-digger/README.md

pdf-gold-digger
====

Pdf information extraction library based on [pdf.js](https://mozilla.github.io/pdf.js/)
and [node.js](https://nodejs.org).

![GitHub](https://img.shields.io/github/license/vane/pdf-gold-digger)
![npm](https://img.shields.io/npm/v/pdf-gold-digger)
![doc](https://vane.pl/pdf-gold-digger/badge.svg)

## Install
```npm install -g pdf-gold-digger```

## Usage
```bash
pdfdig -i some_file.pdf
```  

## Avaliable commands

```bash
pdfdig -h
ex. pdfdig -i input-file -o output_directory -f json
  
  --input  or  -i   pdf file location (required)
  --output or  -o   pdf file location (optional default "out")
  --debug  or  -d   show debug information (optional - default "false")
  --format or  -f   format (optional - default "text") - ("text,json,xml"): 
  --help   or  -h   display this help message
```

## Advanced usage
```bash
git clone https://github.com/vane/pdf-gold-digger
sh demo.sh
```
and see results in ```out``` directory 
                            
## Documentation
[pdf-gold-digger](https://vane.pl/pdf-gold-digger/)

## Features:
- extract text
  - separate each page
  - separate each line
  - separate font information
- extract images
- output formats
  - text ```-f text (default)```
  - json ```-f json```
  - xml  ```-f xml``` 
- specify output directory

## TODO:
- load pdf from remote location
  - from url
- output to html format
- output to markdown format
- output to zip
- extract font
- extract tables
- extract forms
- extract drawings