cu-boulder / ucb2021_base
Drupal 9 2021 base theme for CU Boulder
Installs: 162
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 6
Forks: 1
Open Issues: 2
Language:Twig
Type:drupal-custom-theme
This package is auto-updated.
Last update: 2024-03-01 00:21:11 UTC
README
Drupal 9 Base theme for CU Boulder web properties
Installation
Add below to composer.json
require section:
"cu-boulder/ucb2021_base" : "dev-main"
Add to repositories section:
{
"type": "git",
"url" : "https://github.com/CuBoulder/ucb2021_base.git"
}
Note: This theme is installed and set as the default with the profile. The theme is not intended to be used without the profile or other cu-boulder/*
modules.
To install a local version of Nextpress, follow the steps outlined in the nextpress-project-template
Theme Options
Under /admin/appearance/settings/ucb2021_base
you can manage various theme settings.
- Set default values for the theme in the
ucb2021_base.settings.yml
- Add more settings to the theme in
hook_system_theme_settings_alter
in ucb2021_base.theme
Linting
We are using stylelint and eslint
npm install # install linters
npm run stylelint # lint css
npm run eslint # lint js
Linting is run automatically on all pull requests, however you can lint files locally too.
- configure eslint in
.eslintrc.json
- configure styleint in
.stylelint.json
Directory Structure
.github Directory
Contains the github actions workflow for linting
config
Contains the default values for the theme settings. If new theme settings are added, update ucb2021_base.settings.yml with the default values. You can get the configuration by running lando drush config-get ucb2021_base.settings
and copying the output into the file.
css
- put styles relating the custom paragraphs in css/paragraphs
- put styles from the styleguide in css/styleguide
js
Put JavaScript files here
templates
Twig template overrides go here including those for the custom page and paragraph types. The packages dedicated to the page and paragraph types should only contain config.
ucb2021_base.info.yml
- Define regions
- Add styles to the ckeditor
- Add globally included libraries
ucb2021_base.libraries.yml
Define libraries
ucb2021_base.theme
Add theme hooks
ucb2021_base.breakpoints.yml
This file is used by the Breakpoint and Responsive Image module. These modules are used for making images inserted with the text editor responsive.