South West Communities Website

The South West Communities website, build with a focus on speed performance & SEO best practices.

Features

This project has some lovely features

Installation

System Requirements

To use this project, you'll need the following things on your local machine:

Jekyll

gem install jekyll

NodeJS (8 or greater)

Download and open the NodeJS installer

Up & Running

1. Fork the repo
2. Clone or download the repo into directory of your choice: `git clone https://github.com/your-github-username/our-communities-website.git.
3. Inside the directory run bundle install and npm install
4. Run gulp

Usage

You can modify the theme by changing the settings in _config.yml.

Images

To generate the images needed for the theme, run gulp img;

Site configuration

This site comes with jekyll-seo-tag plugin to make sure your website gets the most useful meta tags. See usage to know how to set it up.

Additionally, in _config.yml you can find custom theme settings under # THEME SETTINGS comment. Here's a brief overview of those custom settings:

• navigation - collection of links that will be shown in the header
• tagline - text that will be displayed on the homepage under the heading.
• hero_img - background image of the homepage hero section

Other settings usually enable/disable certain feature, and are discussed with the next sections.

Contributing

Bug reports, feature requests and contributions are welcome. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The theme is available as open source under the terms of the MIT License.