[Project name]

Overview

This project is a Jekyll-based website template using the GCWeb theme. It integrates a Grunt build system to automate tasks such as minification, copying assets, and serving the site.

Features

• Jekyll for static site generation
• GCWeb Theme for accessibility compliance
• Grunt for task automation

GH Pages dev environement setup

1. Fork the repository
2. Activate GH Pages in your fork
3. Edit your content through Github
4. Open a pull request

Local dev environement setup

Prerequisites

Before you begin, ensure you have the following installed:

• Ruby (Check with ruby -v)
• Bundler (gem install bundler)
• Node.js & npm (Check with node -v and npm -v)
• Grunt CLI (npm install -g grunt-cli)

Installation

1. Fork the repository
2. Clone the repository:

   git clone https://github.com/your-Github-handle/repo-name.git
   cd repo-name

3. Install dependencies:

   bundle install
   npm install

4. Build the assets and serve the site locally:

   bundle exec jekyll serve

   The site should now be accessible at http://localhost:4000/.

Build distribution files

1. To build the distribution files, run:

   grunt

2. The processed files will be available in the dist/ directory.

File Structure

Jekyll website

project-root/
├── _config.yml       # Jekyll configuration
├── Gruntfile.js      # Task running
├── package.json      # Contains the version number of the project
├── Gemfile           # Ruby dependencies
└── README.md         # Project documentation

Contributing

See CONTRIBUTING.md

Security

See SECURITY.md

License

See LICENSE.md