extern/pdf-to-markdown
1
0
Fork 0
mirror of https://github.com/jzillmann/pdf-to-markdown.git synced 2024-12-28 01:08:57 +01:00
Code Issues Packages Projects Releases Wiki Activity
A PDF to Markdown converter
258 Commits 9 Branches 3 Tags 185 MiB
JavaScript 99.5%
HTML 0.3%
CSS 0.2%
78f44a0ad9
Go to file
Johannes Zillmann 78f44a0ad9 Base markdown converter on blocks
2024-04-02 19:57:53 -06:00
docs Release 0.1.1 2017-05-02 19:30:05 +02:00
examples Detect lists & blocks 2024-04-02 16:23:19 -06:00
oldSrc Move core module to root 2024-03-26 10:52:54 -06:00
patches Move core module to root 2024-03-26 10:52:54 -06:00
src Base markdown converter on blocks 2024-04-02 19:57:53 -06:00
test Clean up types 2024-04-02 11:18:55 -06:00
.eslintrc.js Move core module to root 2024-03-26 10:52:54 -06:00
.gitignore Move core module to root 2024-03-26 10:52:54 -06:00
.prettierrc Move core module to root 2024-03-26 10:52:54 -06:00
jest.config.js Fix jest setup deprecation 2024-04-02 18:19:20 -06:00
KNOWN_ISSUES.md Update known issues 2024-03-28 12:03:49 -06:00
LICENSE Add License 2017-03-30 06:55:38 +02:00
package-lock.json Move core module to root 2024-03-26 10:52:54 -06:00
package.json Move core module to root 2024-03-26 10:52:54 -06:00
README.md Improve header detection 2024-03-28 11:39:34 -06:00
tsconfig.json Improve header detection 2024-03-28 11:39:34 -06:00

README.md

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 and/or open pull requests!

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