Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vivliostyle/vivliostyle.js

📖 The power of CSS typesetting, right at your fingertips.
https://github.com/vivliostyle/vivliostyle.js

css epub typesetting vivliostyle

Last synced: 3 months ago
JSON representation

📖 The power of CSS typesetting, right at your fingertips.

Host: GitHub
URL: https://github.com/vivliostyle/vivliostyle.js
Owner: vivliostyle
License: agpl-3.0
Created: 2015-03-30T02:32:08.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2024-04-12T03:18:31.000Z (7 months ago)
Last Synced: 2024-04-14T13:53:29.979Z (7 months ago)
Topics: css, epub, typesetting, vivliostyle
Language: TypeScript
Homepage: https://vivliostyle.org
Size: 331 MB
Stars: 566
Watchers: 40
Forks: 50
Open Issues: 112
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

awesome-readium - Vivliostyle - a document and publication viewer written in JS (Compatible with Readium Web Publications)

README

        


[![GitHub tag][github-tag]][github-tag-url]

[![Build Status][build-status]][build-status-url]

[![Sauce Test Status][sauce-test-status]][sauce-test-status-url]

[![GitHub contributors][contributors]][contributors-url]

[![PR's welcome][pr-welcome]][pr-welcome-url]

Vivliostyle is an open source project for a new typesetting system based on web standard technology.

Vivliostyle.js offers HTML+CSS typesetting and rich paged viewing with EPUB/Web publications support.

🌏 [Vivliostyle.org](https://vivliostyle.org)  

📖 [Documentation](https://vivliostyle.org/documents/)  

🤝 [Join Community](https://vivliostyle.org/community/)  

🕶 [Awesome Vivliostyle](https://github.com/vivliostyle/awesome-vivliostyle)  

💅 [Vivliostyle Themes](https://github.com/vivliostyle/themes#readme)

## Table of contents

- [Packages](#packages)

  - [`@vivliostyle/core`](#vivliostylecore)

  - [`@vivliostyle/viewer`](#vivliostyleviewer)

  - [`@vivliostyle/cli`](#vivliostylecli)

  - [`@vivliostyle/react`](#vivliostylereact)

  - [`@vivliostyle/vfm`](#vivliostylevfm)

  - [`@vivliostyle/print`](#vivliostyleprint)

  - [`create-book`](#create-book)

  - [`create-vivliostyle-theme`](#create-vivliostyle-theme)

- [Contribution](#contribution)

  - [Bug Reports & Feature Requests](#bug-reports--feature-requests)

  - [Contributors ✨](#contributors-)

- [Bronze Sponsor](#bronze-sponsor)

- [License](#license)

- [Credits](#credits)

## Packages

### [`@vivliostyle/core`](https://github.com/vivliostyle/vivliostyle.js/tree/master/packages/core)

[![npm: version](https://flat.badgen.net/npm/v/@vivliostyle/core)](https://www.npmjs.com/package/@vivliostyle/core) [![npm: total downloads](https://flat.badgen.net/npm/dt/@vivliostyle/core)](https://www.npmjs.com/package/@vivliostyle/core)

A core library for HTML+CSS typesetting with EPUB/Web publications support.

See [API Reference](https://docs.vivliostyle.org/#/api) for further details.

### [`@vivliostyle/viewer`](https://github.com/vivliostyle/vivliostyle.js/tree/master/packages/viewer)

[![npm: version](https://flat.badgen.net/npm/v/@vivliostyle/viewer)](https://www.npmjs.com/package/@vivliostyle/viewer) [![npm: total downloads](https://flat.badgen.net/npm/dt/@vivliostyle/viewer)](https://www.npmjs.com/package/@vivliostyle/viewer)

A web app provides intuitive UI for Vivliostyle.

Use [officially-hosted Vivliostyle Viewer](https://vivliostyle.org/viewer/) or download a distribution package from .

- [User Guide](https://docs.vivliostyle.org/#/user-guide)

- [Samples](https://vivliostyle.org/samples/)

### [`@vivliostyle/cli`](https://github.com/vivliostyle/vivliostyle-cli)

[![npm: version](https://flat.badgen.net/npm/v/@vivliostyle/cli)](https://www.npmjs.com/package/@vivliostyle/cli) [![npm: total downloads](https://flat.badgen.net/npm/dt/@vivliostyle/cli)](https://www.npmjs.com/package/@vivliostyle/cli)

A command-line interface of Vivliostyle.

### [`@vivliostyle/react`](https://github.com/vivliostyle/vivliostyle.js/tree/master/packages/react)

[![npm: version](https://flat.badgen.net/npm/v/@vivliostyle/react)](https://www.npmjs.com/package/@vivliostyle/react) [![npm: total downloads](https://flat.badgen.net/npm/dt/@vivliostyle/react)](https://www.npmjs.com/package/@vivliostyle/react)

Use React component as a Vivliostyle renderer.

### [`@vivliostyle/vfm`](https://github.com/vivliostyle/vfm)

[![npm: version](https://flat.badgen.net/npm/v/@vivliostyle/vfm)](https://www.npmjs.com/package/@vivliostyle/vfm) [![npm: total downloads](https://flat.badgen.net/npm/dt/@vivliostyle/vfm)](https://www.npmjs.com/package/@vivliostyle/vfm)

Vivliostyle Flavored Markdown (VFM) is a Markdown syntax optimized for book authoring. It is standardized and published for Vivliostyle and its sibling projects.

### [`@vivliostyle/print`](https://github.com/vivliostyle/vivliostyle-print)

[![npm: version](https://flat.badgen.net/npm/v/@vivliostyle/print)](https://www.npmjs.com/package/@vivliostyle/print) [![npm: total downloads](https://flat.badgen.net/npm/dt/@vivliostyle/print)](https://www.npmjs.com/package/@vivliostyle/print)

Vivliostyle Print allows page-layouting using Vivliostyle Core for printing within a website without destroying the original layout.

### [`create-book`](https://github.com/vivliostyle/create-book)

[![npm: version](https://flat.badgen.net/npm/v/create-book)](https://www.npmjs.com/package/create-book) [![npm: total downloads](https://flat.badgen.net/npm/dt/create-book)](https://www.npmjs.com/package/create-book)

The fastest way to start writing book with Vivliostyle ecosystem.

### [`create-vivliostyle-theme`](https://github.com/vivliostyle/themes/tree/master/packages/create-vivliostyle-theme)

[![](https://img.shields.io/npm/v/create-vivliostyle-theme.svg)](https://npmjs.com/package/create-vivliostyle-theme)

[![npm: total downloads](https://flat.badgen.net/npm/dt/create-vivliostyle-theme)](https://npmjs.com/package/create-vivliostyle-theme)

Create Vivliostyle theme at ease.

## Contribution

- See [Contribution Guide](https://github.com/vivliostyle/vivliostyle.js/tree/master/CONTRIBUTING.md) for development setup.

- [Development Wiki](https://github.com/vivliostyle/vivliostyle.js/wiki/Development)

### Bug Reports & Feature Requests

Please report on [GitHub Issues](https://github.com/vivliostyle/vivliostyle.js/issues).

### Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
_sorotokin
💻

      
_{KAWAKUBO Toru}
💻

      
_{Satoru MATSUSHIMA (℠)}
💻

      
_{Seiya Konno}
💻

      
_{Johannes Wilm}
💻

      
_{Florian Rivoal}
💻

      
_{Satoshi KOJIMA}
💻

    

    

      
_{Masaya Yamauchi}
💻

      
_{Shinyu Murakami}
💻 📖 📢

      
_{Shota Kubota}
💻

      
_{spring-raining}
💻 📖 📢

      
_{Hiroshi Hatake}
💻

      
_takanakahiko
💻

      
_{Yasuaki Uechi}
💻 📖 🎨 📢

    

    

      
_{Zachary Waldowski}
💻

      
_yamasy1549
💻 🎨

      
_{OGATA Katsuhiro}
📝 📋

      
_akabeko
🖋 🤔

      
_youchan
💻 📢

      
_{Yuku Kotani}
💻

      
_{Christoph Päper}
💻

    

    

      
_{Ikko Eltociear Ashimine}
💻

      
_{Takai ayumu}
💻 📢

      
_{daisuke-tanabe}
💻

      
_{Hiroaki KAWAI}
💻

      
_{Enoch Gao}
💻

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

## Bronze Sponsor

- [Hatena Co., Ltd. ](https://github.com/hatena)

## License

Licensed under [AGPL Version 3](https://www.gnu.org/licenses/agpl-3.0.html).

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](https://www.apache.org/licenses/LICENSE-2.0).

## Credits

[![Powered By Vercel](https://www.datocms-assets.com/31049/1618983297-powered-by-vercel.svg)](https://vercel.com/?utm_source=vivliostyle&utm_campaign=oss)

[![Testing Powered By SauceLabs](https://saucelabs.github.io/images/opensauce/powered-by-saucelabs-badge-white.png?sanitize=true "Testing Powered By SauceLabs")](https://saucelabs.com)

[github-tag]: https://img.shields.io/github/v/tag/vivliostyle/vivliostyle.js

[github-tag-url]: https://github.com/vivliostyle/vivliostyle.js/releases

[build-status]: https://github.com/vivliostyle/vivliostyle.js/workflows/CI/badge.svg?branch=master

[build-status-url]: https://github.com/vivliostyle/vivliostyle.js/actions?query=CI

[sauce-test-status]: https://saucelabs.com/buildstatus/vivliostyle-test

[sauce-test-status-url]: https://app.saucelabs.com/u/vivliostyle-test

[contributors]: https://img.shields.io/github/contributors/vivliostyle/vivliostyle.js.svg

[contributors-url]: https://github.com/vivliostyle/vivliostyle.js/graphs/contributors

[pr-welcome]: https://img.shields.io/badge/PRs%20-welcome-brightgreen.svg

[pr-welcome-url]: https://github.com/vivliostyle/vivliostyle.js/blob/master/CONTRIBUTING.md