README.md

Quilt Bulma

This repository exists to package Quilt's modifications to the Bulma CSS framework. This allows us to share it between all of our sites, without relying on hacky approaches such as using the main domain as a pseudo-CDN.

Development

Building

1. Install NodeJS v18 or later
2. Install npm and pnpm
3. Run pnpm i and pnpm build
4. The built files will be placed in the dist/ directory

Creating a distribution

1. Follow the Building steps above
2. Run pnpm pack and a quilt-bulma.zip file will be generated

Releasing

1. Update the version provided in the package.json
2. Commit your changes, and add a tag named vVERSION - for example, v0.0.3
3. Push your changes along with the tag
4. GitHub Actions will build and release automatically

Usage

1. Install quilt-bulma with your favourite npm-alike
2. Make use of the files you'll now find in node_modules/quilt-bulma

Package Structure

• sass/: SCSS files representing our Bulma customisations
• When built, /dist: Contains built CSS files, as well as their minified versions`

Project Credit

This project combines and modifies the following projects:

• Bulma, the CSS framework

• The following CreativeBulma components:

  • bulma-divider, a Bulma extension for dividers with text
  • bulma-tooltip, a Bulma extension for adding tooltips to anything

• The following wikiki components:

  • bulma-timeline, a Bulma extension for vertical timeline layouts