| 1 | # Vivliostyle Core
|
| 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 Core library for HTML+CSS typesetting with EPUB/Web publications support
|
| 10 |
|
| 11 | 🌏 [Vivliostyle website](https://vivliostyle.org)
|
| 12 | 📖 [Documents](https://vivliostyle.org/documents/)
|
| 13 | 🤝 [Join Community](https://vivliostyle.org/community/)
|
| 14 |
|
| 15 | ## Integrate Vivliostyle Core in your project
|
| 16 |
|
| 17 | ```
|
| 18 | npm install @vivliostyle/core
|
| 19 | ```
|
| 20 |
|
| 21 | See [API Reference](https://docs.vivliostyle.org/#/api).
|
| 22 |
|
| 23 | ## Vivliostyle official packages using Vivliostyle Core
|
| 24 |
|
| 25 | - [Vivliostyle Viewer](https://github.com/vivliostyle/vivliostyle.js/tree/master/packages/viewer), CSS typesetting and rich paged viewing in your browser
|
| 26 | - [Vivliostyle CLI](https://github.com/vivliostyle/vivliostyle-cli), a command-line interface for Vivliostyle.
|
| 27 | - [Vivliostyle Print](https://github.com/vivliostyle/vivliostyle-print), allows page-layouting using the Vivliostyle Core for printing within a website without destroying the original layout.
|
| 28 |
|
| 29 | ## Development
|
| 30 |
|
| 31 | - [Contribution Guide](https://github.com/vivliostyle/vivliostyle.js/tree/master/CONTRIBUTING.md) for development setup.
|
| 32 | - [Development Wiki](https://github.com/vivliostyle/vivliostyle.js/wiki/Development).
|
| 33 |
|
| 34 | ## License
|
| 35 |
|
| 36 | Licensed under [AGPL Version 3](https://www.gnu.org/licenses/agpl-3.0.html).
|
| 37 |
|
| 38 | Vivliostyle Core is implemented based on [Peter Sorotokin's EPUB Adaptive Layout implementation](https://github.com/sorotokin/adaptive-layout), which is licensed under [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
|
| 39 |
|
| 40 | Vivliostyle Core contains following components:
|
| 41 |
|
| 42 | - [fast-diff](https://www.npmjs.com/package/fast-diff)
|
| 43 | - Licensed under [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
|
| 44 |
|
| 45 | ## Other Documentation
|
| 46 |
|
| 47 | - [Vivliostyle Documents](https://vivliostyle.org/documents/)
|
| 48 |
|
| 49 | [npm]: https://img.shields.io/npm/v/@vivliostyle/core/latest
|
| 50 | [npm-next]: https://img.shields.io/npm/v/@vivliostyle/core/next
|
| 51 | [npm-url]: https://www.npmjs.com/package/@vivliostyle/core
|
| 52 | [build-status]: https://travis-ci.com/vivliostyle/vivliostyle.js.svg?branch=master
|
| 53 | [build-status-url]: https://travis-ci.com/vivliostyle/vivliostyle.js
|
| 54 | [deps]: https://img.shields.io/david/vivliostyle/vivliostyle.js?path=packages/core
|
| 55 | [deps-url]: https://david-dm.org/vivliostyle/vivliostyle.js/?path=packages/core
|
| 56 | [size]: https://packagephobia.now.sh/badge?p=@vivliostyle/core
|
| 57 | [size-url]: https://packagephobia.now.sh/result?p=@vivliostyle/core
|
| 58 | [downloads]: https://img.shields.io/npm/dw/@vivliostyle/core.svg
|
| 59 | [downloads-url]: https://www.npmjs.com/package/@vivliostyle/core
|