OAG Jekyll Template

Overview

This project is a Jekyll-based website template using the GCWeb theme. It integrates PostCSS for advanced CSS transformations and 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
• PostCSS for enhanced styling capabilities
• Grunt for task automation

GH Pages dev environement setup

• Fork the repository
• Activate GH Pages in your fork
• Edit your content through github
• 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 (node -v and npm -v)
• Grunt CLI (npm install -g grunt-cli)

Installation

1. Clone the repository:

   git clone https://github.com/your-repo/oag-template.git
   cd oag-template
2. Install dependencies:

   bundle install
   npm install
3. Build the assets and serve the site locally:

   bundle exec jekyll serve
   The site should now be accessible at http://localhost:4000/.

Build Process

Grunt automates the following tasks:

• PostCSS: Processes and minifies CSS files
• Copy Task: Moves assets (CSS & images) to the _site folder

File Structure

Jekyll website

project-root/
├── _config.yml       # Jekyll configuration
├── assets/           # CSS, JS, img assets       
├── _site/            # Jekyll's output directory
├── dist/             # Minified and processed assets - **for distribution**
├── Gruntfile.js      # Task running
├── package.json      # Contain the version number of OAG template
├── Gemfile           # Ruby dependencies
└── README.md         # Project documentation

Contributing

See CONTRIBUTING.md

Security

See SECURITY.md

License

See LICENSE.md