mirror of
https://github.com/jzillmann/pdf-to-markdown.git
synced 2024-12-02 04:33:45 +01:00
55ae236928
- fix tests - still run header detection based on heights even if TOC headlines have been identified
39 lines
1.1 KiB
Markdown
39 lines
1.1 KiB
Markdown
# PDF-To-Markdown Converter
|
|
|
|
Javascript library to convert PDF files into Markdown text. Online at http://pdf2md.morethan.io.
|
|
|
|
## Major Changes
|
|
|
|
- **Apr 2017** - 0.1: Initial Release
|
|
|
|
## Use
|
|
|
|
//TBD
|
|
|
|
## Contribute
|
|
|
|
Use the [issue tracker](https://github.com/jzillmann/pdf-to-markdown/issues) and/or open [pull requests](https://github.com/jzillmann/pdf-to-markdown/pulls)!
|
|
|
|
### Useful Build Commands
|
|
|
|
- `npm install` Download all necessary npm packages
|
|
- `npm test` Run the tests
|
|
- `npm test -- --verbose=false './test/Files\.test\.ts' -t "Alice-In-Wonderland.pdf"` Run specific test
|
|
- `npm run test-write` Run the tests and persist possibly new changes on the example file results
|
|
- `npm run lint` Lint the javascript files
|
|
- `npm run format` Run the prettier formatter
|
|
- `npm run build` Compile the typescript files to the `lib` folder
|
|
|
|
## Release
|
|
|
|
//TBD
|
|
|
|
### Test Release locally and use in other projects
|
|
|
|
- `npm link` in the core project
|
|
- `npm link pdf-to-markdown-core` in the target project
|
|
|
|
## Credits
|
|
|
|
[pdf.js](https://mozilla.github.io/pdf.js/) - Mozilla's PDF parsing & rendering platform which is used as a raw parser
|