http://ctbusinessawards.co.uk/2014/

• NodeJS
  • Grunt
  • LESS CSS
• Ruby
  • Jekyll
  • RDiscount

npm install
gem install jekyll

grunt

Visit the url localhost:3000 to view the site.

For testing and proofing we deploy to a staging server before deploying to production.

grunt stage

This push the changes to the gh-pages branch and allows us to view the site via http://beta.ctbusinessawards.co.uk/.

To build the site for deployment:

grunt deploy

This will produce a ./2014 folder that can be uploaded to the server.

During the Alpha/Beta stages, due to constant changes, documentation will be mainly written in-line. With a dedicated section being created at the first major release.

To write a new news post create a new markdown document in the src/_posts folder. Add the following YAML to the top of the page filling in details for title, date and images:

---
layout: news

title:
categories: news
date:
published: true

images:
 main:
 preview:
---

|- _scripts              –  contains useful scripts to help with
|                           development of this project
|- _site                 –  compiled development files (not committed)
|- src
|  |- _includes          –  partial snippets of code to be used
|  |                        in layouts
|  |- _layouts           –  page layouts
|  |- _posts             -  markdown files of news posts
|  |- media              -
|  |- static             -
|  |- {**/*.txt,html,md} -  files for website
|- _config.yml           -  Jekyll config file
|- gruntfile.js
|- package.json
|- readme.md

If you spot any issues please create a ticket via GitHub's Issue Tracker. If the issue is security related please use the contact information below.

In lieu of a formal style guide, take care to maintain the existing coding style.

The source is opened for educational purposes. No rights are assigned to any downloads or forks.

Unless otherwise stated © Trinity Mirror Creative. All rights reserved.