mirror of
https://github.com/pdf2htmlEX/pdf2htmlEX.git
synced 2024-07-07 18:30:34 +00:00
145 lines
6.1 KiB
Markdown
145 lines
6.1 KiB
Markdown
# pdf2htmlEX
|
|
|
|
[](https://travis-ci.org/coolwanglu/pdf2htmlEX)
|
|
|
|
A beautiful demo is worth a thousand words:
|
|
|
|
- **Typography** (LaTeX): [HTML](http://coolwanglu.github.com/pdf2htmlEX/demo/geneve.html) / [PDF](https://github.com/raphink/geneve_1564/raw/master/geneve_1564.pdf)
|
|
- **Cheat Sheet** (math formulas): [HTML](http://coolwanglu.github.com/pdf2htmlEX/demo/cheat.html) / [PDF](http://www.tug.org/texshowcase/cheat.pdf)
|
|
- **Scientific Paper** (text and figures): [HTML](http://coolwanglu.github.com/pdf2htmlEX/demo/demo.html) / [PDF](http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.148.349&rep=rep1&type=pdf)
|
|
- **Full Circle Magazine** (read while downloading): [HTML](http://coolwanglu.github.com/pdf2htmlEX/demo/issue65_en.html) / [PDF](http://dl.fullcirclemagazine.org/issue65_en.pdf)
|
|
- **Git Manual** (CJK support): [HTML](http://coolwanglu.github.com/pdf2htmlEX/demo/chn.html) / [PDF](http://files.cnblogs.com/phphuaibei/git%E6%90%AD%E5%BB%BA.pdf)
|
|
- [Try your own files](https://github.com/coolwanglu/pdf2htmlEX/wiki/UploadDemo)
|
|
|
|
[Browser requirements](https://github.com/coolwanglu/pdf2htmlEX/wiki/Browser-Requirements)
|
|
|
|
## Introduction
|
|
|
|
pdf2htmlEX renders PDF files in HTML, utilizing modern Web technologies.
|
|
It aims to provide an accuracy rendering, while keeping optimized for Web display.
|
|
|
|
pdf2htmlEX is best for text-based PDF files, for example scientific papers with complicated formulas and figures.
|
|
Text, fonts and formats are natively perserved in HTML such that you can still search and copy.
|
|
The generated HTML file is static, Javascript is optional.
|
|
|
|
[Learn more about who and why should use pdf2htmlEX](https://github.com/coolwanglu/pdf2htmlEX/wiki/Introduction)
|
|
|
|
## Features
|
|
|
|
* Precise and native text in HTML
|
|
* Flexible Output
|
|
* Moderate Size
|
|
* More PDF stuffs that you love: links, outlines & printing
|
|
|
|
[Learn more](https://github.com/coolwanglu/pdf2htmlEX/wiki/Feature-List)
|
|
[Compare with others](https://github.com/coolwanglu/pdf2htmlEX/wiki/Comparison)
|
|
|
|
## Get started
|
|
|
|
### Install
|
|
|
|
Thanks to all the packagers!
|
|
|
|
* [Ubuntu PPA](https://launchpad.net/~coolwanglu/+archive/pdf2htmlex) by Lu Wang <coolwanglu@gmail.com>
|
|
* [ArchLinux AUR](https://aur.archlinux.org/packages.php?ID=62426) by Arthur Titeica <arthur.titeica@gmail.com>
|
|
* [Gentoo Overlay](http://gpo.zugaina.org/app-text/pdf2htmlex), gentoo-zh, mrueg or sunrise, by respective packagers.
|
|
* [Homebrew Formula](https://github.com/mxcl/homebrew/blob/master/Library/Formula/pdf2htmlex.rb) by Jamie Ly <me@jamie.ly>
|
|
* [Macports (local repo)](https://github.com/iapain/pdf2htmlEX-macport) by Deepak Thukral <iapain@iapa.in>
|
|
* Windows [N/A](https://github.com/coolwanglu/pdf2htmlEX/wiki/FAQ#wiki-install-windows)
|
|
|
|
### Build from source
|
|
|
|
#### Dependency
|
|
|
|
* CMake, pkg-config
|
|
* GNU Getopt
|
|
* compilers support C++11, for example
|
|
* GCC >= 4.4.6
|
|
* I heard about successful build with Clang
|
|
* **poppler** with xpdf header >= 0.20.0 (compile with **--enable-xpdf-headers**)
|
|
* Install **libpng** (and headers) BEFORE you compile poppler if you want background images generated
|
|
* Install **poppler-data** if your want CJK support
|
|
* **fontforge** (with header files)
|
|
* git version is recommended to avoid annoying compilation issues
|
|
* [Optional] **ttfautohint**
|
|
* run pdf2htmlEX with **--external-hint-tool=ttfautohint** to enable it
|
|
* [For Windows]
|
|
* Cygwin
|
|
* or MinGW, with some modifications to pdf2htmlEX. See [pdf2htmlEX on TeX Wiki](http://oku.edu.mie-u.ac.jp/~okumura/texwiki/?pdf2htmlEX) (in Japanese), special thanks to Haruhiko Okumura
|
|
|
|
#### Compiling
|
|
|
|
git clone --depth 1 git://github.com/coolwanglu/pdf2htmlEX.git
|
|
cd pdf2htmlEX
|
|
cmake . && make && sudo make install
|
|
|
|
## Usage
|
|
|
|
pdf2htmlEX --zoom 1.33 /path/to/foobar.pdf
|
|
|
|
[Quick Start](https://github.com/coolwanglu/pdf2htmlEX/wiki/QuickStart)
|
|
|
|
## FAQ
|
|
|
|
* [Troubleshooting compilation errors](https://github.com/coolwanglu/pdf2htmlEX/wiki/FAQ#wiki-compile)
|
|
* [I want more features](https://github.com/coolwanglu/pdf2htmlEX/wiki/FAQ#wiki-feature_commission)
|
|
* [More...](https://github.com/coolwanglu/pdf2htmlEX/wiki/FAQ)
|
|
|
|
## LICENSE
|
|
|
|
GPLv2 & GPLv3 for most part, MIT License for `share/*`
|
|
|
|
Read `LICENSE` for more detail.
|
|
|
|
### For Online Services
|
|
|
|
You are free and welcome to modify pdf2htmlEX for your online services,
|
|
but you should credit pdf2htmlEX together with a proper link to https://github.com/coolwanglu/pdf2htmlEX
|
|
in the page where the result of pdf2htmlEX (or your modified version) is presented,
|
|
or in the homepage of the service, or a page directly accesible from the homepage of the service.
|
|
You are also encouraged to send me a name and a URL for the purpose of statistics.
|
|
|
|
Read `LICENSE` for more detail.
|
|
|
|
## Contribute
|
|
|
|
Consider how much you have to pay for an alternatve with a similar quality, keeping in mind that pdf2htmlEX is maintained by one person in spare time.
|
|
|
|
* Patches are more than welcome.
|
|
* Or you may prefer [making a donation](http://coolwanglu.github.com/pdf2htmlEX/donate.html), the easier way.
|
|
* [Other ways you may help](https://github.com/coolwanglu/pdf2htmlEX/wiki/FAQ#wiki-help)
|
|
|
|
## Resources
|
|
|
|
* Mailing list <pdf2htmlex@googlegroups.com>
|
|
- Questions are welcome
|
|
- Make sure you have read `man pdf2htmlEX`, [wiki](https://github.com/coolwanglu/pdf2htmlEX/wiki) and [FAQ](https://github.com/coolwanglu/pdf2htmlEX/wiki/FAQ)
|
|
* [pdf2htmlEX Blog](http://pdf2htmlex.blogspot.com)
|
|
- News, announcements and discussions
|
|
* Lu Wang <coolwanglu@gmail.com> or [coolwanglu@twitter](https://twitter.com/coolwanglu)
|
|
- For personal enquiries only
|
|
- Accepting messages in **中文**, **English** or **日本語**
|
|
* IRC Channel [irc://irc.freenode.net/pdf2htmlEX](irc://irc.freenode.net/pdf2htmlEX)
|
|
|
|
## Acknowledge
|
|
|
|
pdf2htmlEX is made possible thanks to the following projects:
|
|
|
|
* [poppler](http://poppler.freedesktop.org/)
|
|
* [Fontforge](http://fontforge.org/)
|
|
* [jQuery](http://jquery.com/)
|
|
|
|
pdf2htmlEX is inspired by the following projects:
|
|
|
|
* pdftops & pdftohtml from poppler
|
|
* MuPDF
|
|
* PDF.js
|
|
* Crocodoc
|
|
* Google Doc
|
|
|
|
### Special Thanks
|
|
|
|
* Hongliang Tian
|
|
* Wanmin Liu
|
|
|