pressbooks / buckram

Opinionated SCSS components for books (web, EPUB and PDF).

Buckram

Opinionated SCSS components for books (web, EPUB and PDF).

Read the docs.

Testing

Install dependencies:

npm install
composer install

Run tests:

npm test

Releasing

Buckram uses Conventional Commits, enforced with commitlint. This facilitates releasing new versions of the package via Release Please. Release notes will be automatically added to a PR based on commits to dev.

To cut a release, merge the current release pull request. This will tag a new GitHub release and update CHANGELOG.md.

Then, run npm publish from the root of the package and enter your one-time password when prompted. For more information on publishing to npm, see the npm publish documentation.