| 1 | # Vivliostyle Viewer
|
| 2 |
|
| 3 | [![npm][npm]][npm-url]
|
| 4 | [![Build Status][build-status]][build-status-url]
|
| 5 | [![deps][deps]][deps-url]
|
| 6 | [![Install Size][size]][size-url]
|
| 7 | [![Downloads][downloads]][downloads-url]
|
| 8 |
|
| 9 | Vivliostyle Viewer is a Web application for HTML+CSS typesetting and rich paged viewing with EPUB/Web publications support.
|
| 10 |
|
| 11 | - Online Vivliostyle Viewer: <https://vivliostyle.org/viewer/>
|
| 12 | - Download Vivliostyle Viewer: <https://vivliostyle.github.io>
|
| 13 | - View samples online: <https://vivliostyle.org/samples/>
|
| 14 |
|
| 15 | ## How to use
|
| 16 |
|
| 17 | ### To use the distribution package `vivliostyle-viewer-*.zip`
|
| 18 |
|
| 19 | 1. Unzip the downloaded ZIP file.
|
| 20 | 2. Open a terminal (or Windows command prompt)
|
| 21 | 3. Run the `start-webserver` or `start-viewer` script (or Windows batch) file located in the unzipped directory. For example:
|
| 22 |
|
| 23 | ```
|
| 24 | $ ./vivliostyle-viewer-latest/start-webserver
|
| 25 | ```
|
| 26 |
|
| 27 | or in Windows command prompt,
|
| 28 |
|
| 29 | ```
|
| 30 | > vivliostyle-viewer-latest\start-webserver
|
| 31 | ```
|
| 32 |
|
| 33 | If a message,
|
| 34 |
|
| 35 | ```
|
| 36 | Please install Node.js or Ruby or Python and rerun this script, or use your favorite HTTP server.
|
| 37 | ```
|
| 38 |
|
| 39 | is shown, install either of them (recommend [Node.js](https://nodejs.org/) and rerun the script, or use your favorite web server.
|
| 40 |
|
| 41 | The `start-webserver` script starts a local web server and opens the default browser. The current directory is used as the root of the web server. Run `start-webserver --help` to see the usage help.
|
| 42 |
|
| 43 | The `start-viewer` script starts a local web server (calls `start-webserver`) and opens Vivliostyle Viewer (located in `./viewer/`) in browser. Run `start-viewer --help` to see the usage help.
|
| 44 |
|
| 45 | ### To use the npm package [`@vivliostyle/viewer`](https://www.npmjs.com/package/@vivliostyle/viewer)
|
| 46 |
|
| 47 | ```
|
| 48 | npm install @vivliostyle/viewer
|
| 49 | ```
|
| 50 |
|
| 51 | Vivliostyle Viewer is located in `./node_modules/@vivliostyle/viewer/lib/`, so you need to start a web server and open this location in the browser to start the Vivliostyle Viewer.
|
| 52 |
|
| 53 | ## Documentation
|
| 54 |
|
| 55 | See online [Vivliostyle Documents](https://vivliostyle.org/documents/) for the latest documents, or open `./docs/` in the distribution package using local web server.
|
| 56 |
|
| 57 | ## Bug reports & feature requests
|
| 58 |
|
| 59 | Please send them to
|
| 60 |
|
| 61 | - GitHub Issues: <https://github.com/vivliostyle/vivliostyle.js/issues>
|
| 62 |
|
| 63 | ## Source code
|
| 64 |
|
| 65 | - Vivliostyle.js on GitHub: <https://github.com/vivliostyle/vivliostyle.js>
|
| 66 |
|
| 67 | ## License
|
| 68 |
|
| 69 | Licensed under [AGPL Version 3](https://www.gnu.org/licenses/agpl-3.0.html).
|
| 70 |
|
| 71 | [npm]: https://img.shields.io/npm/v/@vivliostyle/viewer/latest
|
| 72 | [npm-next]: https://img.shields.io/npm/v/@vivliostyle/viewer/next
|
| 73 | [npm-url]: https://www.npmjs.com/package/@vivliostyle/viewer
|
| 74 | [build-status]: https://travis-ci.com/vivliostyle/vivliostyle.js.svg?branch=master
|
| 75 | [build-status-url]: https://travis-ci.com/vivliostyle/vivliostyle.js
|
| 76 | [deps]: https://img.shields.io/david/vivliostyle/vivliostyle.js?path=packages/viewer
|
| 77 | [deps-url]: https://david-dm.org/vivliostyle/vivliostyle.js/?path=packages/viewer
|
| 78 | [size]: https://packagephobia.now.sh/badge?p=@vivliostyle/viewer
|
| 79 | [size-url]: https://packagephobia.now.sh/result?p=@vivliostyle/viewer
|
| 80 | [downloads]: https://img.shields.io/npm/dw/@vivliostyle/viewer.svg
|
| 81 | [downloads-url]: https://www.npmjs.com/package/@vivliostyle/viewer
|