English | 日本語
Adoption of the Official Theme

Adoption of the Official Theme

A generic theme that is likely to be used by many users will be adopted as the official theme. Official themes are managed in the vivliostyle/themes repository and published as npm packages with the name @vivliostyle/theme-*.

Conditions for Adoption

The conditions for adoption as an official theme are as follows:

  • The design and primary purpose of the theme must be different from the existing official themes.
  • The theme must meet the theme specifications.
  • Sign the Contributor License Agreement.
  • Comply with the Code of Conduct.

How to Adopt

Please send a pull request to the vivliostyle/themes repository.

  • The theme name should be @vivliostyle/theme-*.
  • Include the source code in packages/@vivliostyle/theme-*.

If your theme is accepted as an official theme, you will be given the following privileges as a maintainer of the vivliostyle/themes repository:

  • Push to the repository
  • Triage issues
  • Review and merge pull requests