mirror of
https://github.com/jzillmann/pdf-to-markdown.git
synced 2024-11-07 08:24:34 +01:00
A PDF to Markdown converter
docs | ||
examples | ||
src | ||
test | ||
.babelrc | ||
.eslintrc | ||
.gitignore | ||
FUNDING.yml | ||
LICENSE | ||
package-lock.json | ||
package.json | ||
README.md | ||
webpack.config.js |
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
- Find the current version at https://jzillmann.github.io/pdf-to-markdown-staging/
- Help me
- 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 packagesnpm run lint
Lint the javascript filesnpm run test
Run testsnpm run check
Lint & Testnpm run build
Build the dev versionnpm run start
Run the app on an server (useful for loading of worker.js and cmaps)npm run watch
Continuously build the projectopen build/index.html
Open the build project in your default browsernpm run release
Build production versionnpm 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