Skip to content

NHSLeadership/nhsblocks

Repository files navigation

WordPress Gutenberg Blocks for NHS Theme

This repository houses the native Gutenberg blocks for the Nightingale WordPress theme from NHS Leadership Academy. This is a standalone plugin, but is intended to be used in concert with the Nightingale theme. The plugin and theme together complete the WordPress deployment of the NHSUK Front-end design.

Requirements

This plugin requires minimum Wordpress 5.0

If you are running the Gutenberg plugin as a separate entity (Gutenberg is built in to the core of WordPress - this ONLY applies if you also have the plugin) then the NHSBlocks plugin may have some unexpected behavior. The NHSBlocks plugin is built to use the core version of Gutenberg included in WordPress.

Whilst designed for the Nightingale WordPress theme, this plugin is a standalone and has its own css included, so can be included to any WordPress site meeting the minimum requirements above. If you ARE running the Nightingale theme, the plugin stylesheets will be suppressed and the the theme stylesheet will cover everything so there will be no duplication of css.

Deployment Instructions

Download the nhsblocks.zip from this repository. Install this to your wordpress via admin > plugins > add new > upload. Go to your wordpress admin, and activate the NHS Blocks plugin. Then edit your pages, your new blocks are all homed in a new category called NHS Front-end Blocks - select any of these and edit away. Variations of the blocks are found in the right hand panel under Styles

Development Instructions

To develop your own modifications, you will need to download the full repo from GitHub - ideally you should be in your wp-content/plugins folder.

Once you have this locally, you will need to change directory to wp-content/plugins/nhsblocks. Start by running npm run install to download and setup all the required node modules.

  • Any changes to styles can be made in the assets/scss folder. To regenerate the css, you will need to run npm run build-scss.
  • Any changes to the blocks themselves can be made in the src folder. Once changes are complete, you will need to regenerate the js by running npm run build. This will generate new files in the build folder.
  • If you then wish to export your changes to any other sites, you will need to run npm run zip to regenerate the nhsblocks.zip file.

Any improvements, bug fixes or amendments should also be submitted back as pull requests to our GitHub repo so that the whole community can benefit from the work.

Credits

This plugin was written by Tony Blacker, NHS Leadership Academy Digital Delivery Team. It is based on the tutorial provided by Morten Rand-Hendriksen and extended out to match the NHSUK Front-end library components