extern/pdf-to-markdown
1
0
Fork 0
mirror of https://github.com/jzillmann/pdf-to-markdown.git synced 2024-12-17 20:10:43 +01:00
Code Issues Packages Projects Releases Wiki Activity
2c7caaa5d3
pdf-to-markdown/README.md
Christian Oliff 4faf64932e Fix typo (#12)
2019-11-08 18:02:31 +01:00

1.3 KiB
Raw Blame History

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

  • Apr 2017 - 0.1: Initial Release

Contribute

Use the issue tracker and/or open pull requests!

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 - Mozilla's PDF parsing & rendering platform which is used as a raw parser