README.md

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

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

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):

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 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

License

Licensed under AGPL Version 3.

Vivliostyle Core is implemented based on Peter Sorotokin's EPUB Adaptive Layout implementation, which is licensed under Apache License, Version 2.0.

Credits