Vivliostyle.js

<img src="https://vivliostyle.org/assets/vivliostyle-logo.svg" width="300" alt="Vivliostyle" /><br/>

[![GitHub tag][github-tag]][github-tag-url] [![Build Status][build-status]][build-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
📖 Documentation
🤝 Join Community
🕶 Awesome Vivliostyle
💅 Vivliostyle Themes

Table of contents

<!-- START doctoc generated TOC please keep comment here to allow auto update --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

• Packages
  • @vivliostyle/core
  • @vivliostyle/viewer
  • @vivliostyle/cli
  • @vivliostyle/react
  • @vivliostyle/vfm
  • @vivliostyle/print
  • create-book
  • create-vivliostyle-theme
• Contribution
  • Bug Reports & Feature Requests
  • Contributors ✨
• Bronze Sponsor
• License

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Packages

@vivliostyle/core

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

See API Reference for further details.

@vivliostyle/viewer

A web app provides intuitive UI for Vivliostyle.

Use officially-hosted Vivliostyle Viewer or download a distribution package from https://vivliostyle.github.io.

• User Guide
• Samples

@vivliostyle/cli

A command-line interface of Vivliostyle.

@vivliostyle/react

Use React component as a Vivliostyle renderer.

@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

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

create-book

The fastest way to start writing book with Vivliostyle ecosystem.

create-vivliostyle-theme

Create Vivliostyle theme at ease.

Contribution

• See Contribution Guide for development setup.
• Development Wiki

Bug Reports & Feature Requests

Please report on GitHub Issues.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tbody> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/sorotokin"><img src="https://avatars3.githubusercontent.com/u/11699780?v=4?s=80" width="80px;" alt="sorotokin"/><br />_{<b>sorotokin</b>}</a><br /><a href="https://github.com/vivliostyle/vivliostyle.js/commits?author=sorotokin" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="http://kwkbtr.info"><img src="https://avatars3.githubusercontent.com/u/3595560?v=4?s=80" width="80px;" alt="KAWAKUBO Toru"/><br />_{<b>KAWAKUBO Toru</b>}</a><br /><a href="https://github.com/vivliostyle/vivliostyle.js/commits?author=kwkbtr" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://bibi.epub.link"><img src="https://avatars0.githubusercontent.com/u/3631499?v=4?s=80" width="80px;" alt="Satoru MATSUSHIMA (℠)"/><br />_{<b>Satoru MATSUSHIMA (℠)</b>}</a><br /><a href="https://github.com/vivliostyle/vivliostyle.js/commits?author=satorumurmur" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="http://null.ly"><img src="https://avatars2.githubusercontent.com/u/291185?v=4?s=80" width="80px;" alt="Seiya Konno"/><br />_{<b>Seiya Konno</b>}</a><br /><a href="https://github.com/vivliostyle/vivliostyle.js/commits?author=nulltask" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="http://www.johanneswilm.org"><img src="https://avatars2.githubusercontent.com/u/595512?v=4?s=80" width="80px;" alt="Johannes Wilm"/><br />_{<b>Johannes Wilm</b>}</a><br /><a href="https://github.com/vivliostyle/vivliostyle.js/commits?author=johanneswilm" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://florian.rivoal.net"><img src="https://avatars0.githubusercontent.com/u/113268?v=4?s=80" width="80px;" alt="Florian Rivoal"/><br />_{<b>Florian Rivoal</b>}</a><br /><a href="https://github.com/vivliostyle/vivliostyle.js/commits?author=frivoal" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://skoji.jp"><img src="https://avatars1.githubusercontent.com/u/119629?v=4?s=80" width="80px;" alt="Satoshi KOJIMA"/><br />_{<b>Satoshi KOJIMA</b>}</a><br /><a href="https://github.com/vivliostyle/vivliostyle.js/commits?author=skoji" title="Code">💻</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="http://unageanu.hatenablog.com/"><img src="https://avatars2.githubusercontent.com/u/11205?v=4?s=80" width="80px;" alt="Masaya Yamauchi"/><br />_{<b>Masaya Yamauchi</b>}</a><br /><a href="https://github.com/vivliostyle/vivliostyle.js/commits?author=unageanu" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/MurakamiShinyu"><img src="https://avatars1.githubusercontent.com/u/3324737?v=4?s=80" width="80px;" alt="Shinyu Murakami"/><br />_{<b>Shinyu Murakami</b>}</a><br /><a href="https://github.com/vivliostyle/vivliostyle.js/commits?author=MurakamiShinyu" title="Code">💻</a> <a href="https://github.com/vivliostyle/vivliostyle.js/commits?author=MurakamiShinyu" title="Documentation">📖</a> <a href="#talk-MurakamiShinyu" title="Talks">📢</a></td> <td align="center" valign="top" width="14.28%"><a href="https://blog.kubosho.com"><img src="https://avatars0.githubusercontent.com/u/430267?v=4?s=80" width="80px;" alt="Shota Kubota"/><br />_{<b>Shota Kubota</b>}</a><br /><a href="https://github.com/vivliostyle/vivliostyle.js/commits?author=kubosho" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://harusamex.com"><img src="https://avatars1.githubusercontent.com/u/1771005?v=4?s=80" width="80px;" alt="spring-raining"/><br />_{<b>spring-raining</b>}</a><br /><a href="https://github.com/vivliostyle/vivliostyle.js/commits?author=spring-raining" title="Code">💻</a> <a href="https://github.com/vivliostyle/vivliostyle.js/commits?author=spring-raining" title="Documentation">📖</a> <a href="#ta