cehd-bootstrap v0.1.1

CE+HD Bootstrap

CE+HD Modifications and Theme for Bootstrap v4

Bootstrap Version

Currently v4.0.0-alpha.5

Getting Started

Prerequisites

1. Install Node

• Node install options and instruction

2. Install Grunt command line tools $ npm install -g grunt-cli

• Grunt Getting Started

3. Install Ruby, install Bundler

• Ruby is required to run Jekyll
• Jekyll and Ruby install instructions for Windows Users

Install

1. Install Node Modules $ npm install
2. Install Gems $ bundle install

Usage

Modify SCSS

Modify Bootstrap variables located at scss/_cehd-variables.scss

For Example:

$gray-dark:           #373a3c !default;
$gray:                #55595c !default;

$lead-font-size:      1.25rem !default;
$lead-font-weight:    300 !default;

Generate CSS

SCSS is compiled into CSS using a Grunt task.

1. Run $ grunt dist to generate CSS
2. CSS will be copied to dist/css/
3. Copy CSS files in dist/css/ for use elsewhere

• Expanded .css and minified .min.css files available

Bootstrap JS

Bootstrap JS is concatenated, babelified and minified from the source directory to ensure version compatibility.

Documentation

Documentation is available on Github pages. It has been modified from the official Bootstrap repo.

Run Locally

The documentation is built by Jekyll. To view locally:

• run $ jekyll serve
• browse to http://localhost:4000/cehd-web-common/cehd-bootstrap/

Update Github pages

• Update the _site directory by running $ jekyll build
• Commit and push the updated _site directory to master
• Push _site directory to the gh-pages branch $ git subtree push --prefix _site origin gh-pages

Watch Tasks

To automatically recompile CSS when changes are made run $ grunt watch.

Auto-regeneration is enabled in Jekyll by default. To disable use $ jekyll serve --no-watch instead.

Todo

Repo todo items.

• Build against Bootstrap 4 final release