Drupal theme

Install CivicTheme

composer require drupal/civictheme

Alternatively, you can download the latest version from Drupal.org and place into the desired location.

Note that Drupal core has a known issue and a patch would need to be installed on your site.

Install Contrib modules

CivicTheme has required dependencies on contrib modules and optional dependencies on search_api.

These dependencies need to be downloaded and installed before you are able to install CivicTheme.

GovCMS SaaS specific installation instructions

See Using in GovCMS SaaS for specific GovCMS SaaS instructions.

Usage

CivicTheme can be used as a no-code Drupal theme with some of the configurations done on theme settings page.

Enabling contrib modules

Due to Drupal allowing themes to declare module dependencies, but does not yet allow those modules to be enabled automatically).

The contrib module dependencies need to enabled manually or with an automated script:

Enable required modules only

Enable required and optional modules

Clear caches

Enable CivicTheme

Enable the theme in UI or with Drush:

Provision content

CivicTheme comes with pre-set Block Content blocks configuration. Since Drupal does not support running install hooks in themes, a custom content provisioning script has to be used.

  1. Login to the local instance of your site.

  2. Navigate to /admin/appearance/settings/<SUBTHEME_MACHINE_NAME>\

  1. Press "Provision content" button.

  2. Navigate to the homepage and observe that all blocks and menus are present.

  3. Export config for created entities:

Depending on your deployment workflow, you may need to repeat this step after deployment to your hosting provider environment.

After deployment and provisioning your remote feature environment should look like a default CivicTheme site without homepage content.

Troubleshooting

Content not appearing after provisioning

  • Clear caches: drush cr

  • Check that your sub-theme (not the base CivicTheme theme) is set as the default

  • Verify all required modules are enabled: check the module dependencies in the theme info.yml

Styling not applied

  • Confirm the dist directory exists in your sub-theme

  • Clear caches and hard-refresh the browser

  • Check the browser console for 404 errors on CSS/JS files

Module dependency errors

  • Run composer require for any missing packages

  • Ensure you enabled module dependencies before enabling the theme

Setting up a sub-theme

See Sub-theme section to create a sub-theme and use CivicTheme as a base theme.

Last updated

Was this helpful?