dof-dss/nicsdru_unity_theme

Drupal theme for Unity sites

10.1.17 2024-10-09 11:24 UTC

Requires

• php: >=8.0

MIT

• David Corbett

• theme
• drupal

README

This repository contains code for a Drupal 8 theme from which NICS sites could be sub-themed from.

Table of contents

• Quick start
• What's included
• Bugs and feature requests
• Using the NPM scripts
• Sub-theming
• Documentation

Quick start

• Download the latest release or clone the repo: git clone https://github.com/dof-dss/nicsdru_unity_theme.git
• brew install libjpeg
• npm install

What's included

The theme uses NPM scripts and packages to create tooling to:

• write and compile scss to css
• apply appropriate prefixing for css rules
• write and uglify js
• detect features the user’s browser has to offer (via Modernizr)
• code linting
• optimise and compress images for the web

Within the download you'll find the following directories and files, logically grouping common assets, you'll see something like this:

nicsdru_unity_theme/
└── config/
│   ├── install/
│   ├── .sass-lint.yml
│   ├── modernizr-config.json
│   ├── postcss.config.js
└── css/
└── images/
└── js/
└── src/
│   ├── images/
│   ├── js/
│   ├── scss/
│   ├── styleguide/
└── templates/
│   ├── block/
│   ├── content/
│   ├── field/
│   ├── layout/
│   ├── misc/
│   ├── navigation/
│   ├── user/
└── .gitignore
└── composer.json
└── imagemin.js
└── nicsdru_unity_theme.breakpoints.yml
└── nicsdru_unity_theme.info.yml
└── nicsdru_unity_theme.layouts.yml
└── nicsdru_unity_theme.libraries.yml
└── nicsdru_unity_theme.theme
└── package.json
└── README.md
└── screenshot.png

Using the NPM scripts

The package.json includes the following commands and tasks:

Run npm run to see all the npm scripts.

Documentation

Guidance on styling and developer helpers on how to use this theme is available here.