1
0
mirror of https://github.com/pdf2htmlEX/pdf2htmlEX.git synced 2024-12-22 04:50:09 +00:00
pdf2htmlEX/README.md

104 lines
4.5 KiB
Markdown
Raw Normal View History

2013-01-25 13:11:27 +00:00
# pdf2htmlEX
2013-01-25 18:10:07 +00:00
[![Build Status](https://travis-ci.org/coolwanglu/pdf2htmlEX.png?branch=master)](https://travis-ci.org/coolwanglu/pdf2htmlEX)
2012-09-26 14:44:50 +00:00
2012-09-07 17:50:18 +00:00
A beautiful demo is worth a thousand words:
2012-08-04 18:25:47 +00:00
2013-09-10 12:33:50 +00:00
- **Bible de Genève, 1564** (fonts and typography): [HTML](http://coolwanglu.github.com/pdf2htmlEX/demo/geneve.html) / [PDF](https://github.com/raphink/geneve_1564/raw/master/geneve_1564.pdf)
2013-05-04 15:39:08 +00:00
- **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)
2013-03-12 13:26:31 +00:00
- [Try your own files](https://github.com/coolwanglu/pdf2htmlEX/wiki/UploadDemo)
2013-03-19 11:00:40 +00:00
[Browser requirements](https://github.com/coolwanglu/pdf2htmlEX/wiki/Browser-Requirements)
2013-03-12 13:18:44 +00:00
2013-05-10 14:25:05 +00:00
### Introduction
2012-08-28 09:54:27 +00:00
2013-01-31 11:25:53 +00:00
pdf2htmlEX renders PDF files in HTML, utilizing modern Web technologies.
2013-07-05 21:59:45 +00:00
It aims to provide an accurate rendering, while keeping optimized for Web display.
2012-08-04 18:03:53 +00:00
2013-01-31 11:25:53 +00:00
pdf2htmlEX is best for text-based PDF files, for example scientific papers with complicated formulas and figures.
2013-07-05 21:59:45 +00:00
Text, fonts and formats are natively preserved in HTML such that you can still search and copy.
The generated HTML file is static, with optional features powered by JavaScript.
2012-08-28 09:54:27 +00:00
2013-05-04 17:58:27 +00:00
[Learn more about who and why should use pdf2htmlEX](https://github.com/coolwanglu/pdf2htmlEX/wiki/Introduction)
2012-12-12 08:54:48 +00:00
2013-05-10 14:25:05 +00:00
### Features
2012-08-04 18:03:53 +00:00
2013-05-04 17:52:53 +00:00
* Precise and native text in HTML
2013-05-04 13:33:55 +00:00
* Flexible Output
* Moderate Size
* More PDF stuffs that you love: links, outlines & printing
2013-09-21 05:58:00 +00:00
* Experimental: SVG background output & Type 3 font conversion
2013-02-01 08:16:01 +00:00
2013-05-04 17:52:53 +00:00
[Learn more](https://github.com/coolwanglu/pdf2htmlEX/wiki/Feature-List)
2013-02-02 06:43:40 +00:00
[Compare with others](https://github.com/coolwanglu/pdf2htmlEX/wiki/Comparison)
2012-08-04 18:03:53 +00:00
2013-05-10 14:25:05 +00:00
### Wiki Portals
2013-05-10 14:12:56 +00:00
* [Wiki Home](https://github.com/coolwanglu/pdf2htmlEX/wiki)
* [Download](https://github.com/coolwanglu/pdf2htmlEX/wiki/Download)
* [Building](https://github.com/coolwanglu/pdf2htmlEX/wiki/Building)
* [Quick Start](https://github.com/coolwanglu/pdf2htmlEX/wiki/QuickStart)
2013-05-10 14:22:47 +00:00
* [How to contribute](https://github.com/coolwanglu/pdf2htmlEX/wiki/Contribute)
2013-09-08 06:55:39 +00:00
* [How to report](https://github.com/coolwanglu/pdf2htmlEX/wiki/How-to-report)
2013-05-10 14:12:56 +00:00
* [FAQ](https://github.com/coolwanglu/pdf2htmlEX/wiki/FAQ)
2013-05-10 14:25:05 +00:00
### LICENSE
2012-08-04 18:03:53 +00:00
2013-07-05 21:59:45 +00:00
GPLv3 with additional terms (see below) for most parts, MIT License for `share/*`
2013-05-09 14:59:29 +00:00
Read `LICENSE` for more detail.
2012-08-04 18:03:53 +00:00
2013-05-10 14:25:05 +00:00
#### For Online Services
2012-09-07 10:23:38 +00:00
2013-05-09 14:59:29 +00:00
You are free and welcome to modify pdf2htmlEX for your online services,
2013-05-10 08:46:11 +00:00
but you should credit pdf2htmlEX if your service involves "online conversion" facilitated by pdf2htmlEX.
2013-05-09 14:59:29 +00:00
You are also encouraged to send me a name and a URL for the purpose of statistics.
2012-09-07 10:23:38 +00:00
2013-05-09 14:59:29 +00:00
Read `LICENSE` for more detail.
2013-05-10 14:25:05 +00:00
### Resources
2013-01-30 04:21:57 +00:00
2013-09-05 12:42:24 +00:00
* [pdf2htmlEX Blog](http://pdf2htmlex.blogspot.com) [[RSS Subscribe]](http://pdf2htmlex.blogspot.com/feeds/posts/default)
2013-07-05 21:59:45 +00:00
- News and announcements
2013-09-05 12:42:24 +00:00
* Mailing list <pdf2htmlex@googlegroups.com> [[Subscribe]](https://groups.google.com/forum/#!forum/pdf2htmlex)
2013-09-08 06:56:42 +00:00
- Discussions and announcements
2013-09-05 12:42:24 +00:00
- Before you ask, please read `man pdf2htmlEX` and [wiki](https://github.com/coolwanglu/pdf2htmlEX/wiki)
2013-09-08 06:55:39 +00:00
### Contacts
2013-09-18 12:24:48 +00:00
* 王璐 (Lu Wang) <coolwanglu@gmail.com> or [coolwanglu@twitter](https://twitter.com/coolwanglu)
2013-09-08 06:55:39 +00:00
- For general and person questions
- If you want to report an issue, please refer to [How to report](https://github.com/coolwanglu/pdf2htmlEX/wiki/How-to-report)
2013-05-06 04:54:13 +00:00
- Accepting messages in **中文**, **English** or **日本語**
2013-09-08 06:55:39 +00:00
- Messages are checked on a regular basis so please expect some delay before I can reply.
2013-09-06 06:56:28 +00:00
2013-09-05 12:42:24 +00:00
<!--
2013-05-05 09:24:48 +00:00
* IRC Channel [irc://irc.freenode.net/pdf2htmlEX](irc://irc.freenode.net/pdf2htmlEX)
2013-09-05 12:42:24 +00:00
-->
2013-05-05 09:24:48 +00:00
2013-05-10 14:38:59 +00:00
### Acknowledgements
2012-08-28 09:54:27 +00:00
2012-09-21 13:38:23 +00:00
pdf2htmlEX is made possible thanks to the following projects:
2012-09-21 13:35:27 +00:00
2012-09-21 13:38:23 +00:00
* [poppler](http://poppler.freedesktop.org/)
* [Fontforge](http://fontforge.org/)
2012-09-22 06:41:29 +00:00
* [jQuery](http://jquery.com/)
2012-09-21 13:35:27 +00:00
2012-09-18 16:45:20 +00:00
pdf2htmlEX is inspired by the following projects:
2012-08-04 18:03:53 +00:00
* pdftops & pdftohtml from poppler
2012-08-11 11:55:06 +00:00
* MuPDF
2012-08-04 18:03:53 +00:00
* PDF.js
* Crocodoc
* Google Doc
2013-05-10 14:25:05 +00:00
#### Special Thanks
2012-08-28 09:54:27 +00:00
2013-02-05 14:53:14 +00:00
* Hongliang Tian
* Wanmin Liu
2012-08-04 18:03:53 +00:00