https://github.com/jzillmann/pdf-to-markdown

A PDF to Markdown converter
https://github.com/jzillmann/pdf-to-markdown

markdown pdf-converter

Last synced: 20 days ago
JSON representation

A PDF to Markdown converter

• Host: GitHub
• URL: https://github.com/jzillmann/pdf-to-markdown
• Owner: jzillmann
• License: mit
• Created: 2017-01-06T12:17:43.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-06-19T05:03:02.000Z (5 months ago)
• Last Synced: 2024-10-01T23:21:55.514Z (about 1 month ago)
• Topics: markdown, pdf-converter
• Language: JavaScript
• Homepage: https://pdf2md.morethan.io
• Size: 185 MB
• Stars: 1,181
• Watchers: 16
• Forks: 191
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • Funding: FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• project-awesome - jzillmann/pdf-to-markdown - A PDF to Markdown converter (JavaScript)
• awesome-hacking-lists - jzillmann/pdf-to-markdown - A PDF to Markdown converter (JavaScript)
• jimsghstars - jzillmann/pdf-to-markdown - A PDF to Markdown converter (JavaScript)

README

        
# PDF-To-Markdown Converter

Javascript tool to parse PDF files and convert them into Markdown format. Online version at http://pdf2md.morethan.io!

## Major Changes

- **2020/2021** Currently separating the parsing logic from the frontent in order to make it separately available. 

  - [Branch modularize](https://github.com/jzillmann/pdf-to-markdown/tree/modularize) 

  - Find the current version at https://jzillmann.github.io/pdf-to-markdown-staging/

  - [Help me](https://github.com/jzillmann/pdf-to-markdown/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+milestone%3Av2) 

- **Apr 2017** - 0.1: Initial Release

## 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 run lint``` Lint the javascript files

- ```npm run test``` Run tests

- ```npm run check``` Lint & Test

- ```npm run build``` Build the dev version

- ```npm run start``` Run the app on an server (useful for loading of worker.js and cmaps)

- ```npm run watch``` Continuously build the project

- ```open build/index.html``` Open the build project in your default browser

- ```npm run release``` Build production version

- ```npm run deploy``` Build production version & move it to the github pages fodler

#### Release

- Increase version in package.json

- ```npm run deploy```

- commit & push

- tag with

  - _git tag -a $releaseVersion -m "$releaseVersion release"_

  - _git push --tags_

## Credits

[pdf.js](https://mozilla.github.io/pdf.js/) - Mozilla's PDF parsing & rendering platform which is used as a raw parser