Ocean

The website for the CSIS Stephenson Ocean Security project. It is built on the CSIS Jekyll Starter that utilizes gulp, Sass, Autoprefixer, PostCSS, Webpack, imagemin, and Browsersync to speed-up development.

Table of Contents

• Quick-Start Instructions
• Usage
  • Local Development
  • Build for Production
  • See More Commands
  • Jekyll
• What's Included

Quick-start Instructions

$ git clone https://github.com/CSIS-iLab/ocean.git
$ cd csis-jekyll-starter
$ bundle install --path vendor/bundle
$ npm install
$ npm start

Usage

Local Development

This will give you file watching, browser synchronization, auto-rebuild, CSS injecting, etc.

$ npm start

Build for Production

This will set the JEKYLL_ENV to production and use the production config file(s) set in frasco.config.js to override default settings.

$ npm run build

See More Commands

This will display all available commands, such as running eslint or imagemin independently.

$ npm run

Jekyll

You can also use any of the default Jekyll commands listed in their docs.

What's Included

For more information on what is included and modifying the default configuration, see the What's Included guide.

• gulp
• Sass
• Stylelint
• Autoprefixer
• PostCSS
• Webpack
• UglifyJS
• imagemin
• Browsersync

Contributing

Branching

When modifying the code base, always make a new branch. Unless it's necessary to do otherwise, all branches should be created off of master.

Branches should use the following naming conventions:

When ready to merge, submit a Pull Request into master. All code will be reviewed by the lead developer on the project before being merged into master.

Commit Messages

Write clear and concise commit messages describing the changes you are making and why. If there are any issues associated with the commit, include the issue # in the commit title.

CSS Styles

• This project uses the BEM naming convention.
• This project uses Stylelint to maintain a consistent code style. Errors are flagged in the console during development and can be automatically fixed by running npm run stylelint-fix.

Includes

When creating a Jekyll include that accepts parameters, add it to the Includes document with a description of what the include is, how to call it, and what the parameters are.

Copyright / License

Copyright © 2018 CSIS iDeas Lab under the MIT License.