[![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
-
@vivliostyle/core
- @vivliostyle/viewer
- @vivliostyle/cli
- @vivliostyle/react
- @vivliostyle/vfm
- @vivliostyle/print
- create-book
- create-vivliostyle-theme
- Bug Reports & Feature Requests
- Contributors ✨
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
@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):
This project follows the all-contributors specification. Contributions of any kind welcome!
Bronze Sponsor
Generative AI Policy
This project uses generative AI tools in its development and discloses that use in AI_POLICY.md, the Vivliostyle organization's generative AI policy.
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.
[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 [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