Skip to content

glasskube/theme

Repository files navigation

Glasskube Theme

This is the official theme used by Glasskube products. It is consists of a customized build of bootstrap, as well as some additional components and utilities (see below).

Used by the Glasskube package manager.

Features

  • All features of bootstrap

  • Modularized build approach
    Choose only the parts you need.

  • Fonts, icons included
    We use bootstrap icons and the beautiful Inter an Poppins fonts.

  • Beautiful light and dark mode
    See bootstrap documentation.

  • Sensible theme colors
    We selected a small number of theme colors that are used consistently throughout the theme.

  • Streamlined typography for long-form text
    Use the .prose-content, .text-justified and .text-hyphens CSS classes for your texts.

Installation

The Glasskube theme is published as an NPM package. To add it to you your project:

  1. Install @glasskube/theme using your preferred node package manager
  2. Import the theme into your project (see Usage)

Usage

The Glasskube theme is distributed in two variants: Source and prebuilt. The source files can be imported into an SCSS file, while the prebuilt CSS variant can be used as-is.

Contributing

Contributions are welcome! Please open a new issue before you start working, so we can discuss the planned changes. If you make any changes, please make sure that they are viewable in the examples file at examples/index.html. Before committing your changes, run npm run build and npm run prettier:check, in order to ensure that your changes conform with our code style standards.