gpmd / playbook

This site is all about how we work and make things, how we operate as a company.

Home Page:http://playbook.gpmd.io/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Playbook

This site is all about how we work and make things, how we operate as a company.

http://playbook.gpmd.io/

About

This is a static site built using Jekyll and hosted on Github Pages.

Requirements for local development

Installation

Clone the repo into your project folder:

$ git clone https://github.com/gpmd/playbook.git .

Run git fetch and check out the gh-pages branch. From now on all work should be done on the gh-pages branch.

Basic Jekyll usage

To build the project:

$ sass assets/stylesheets/main.scss:assets/stylesheets/main.css && jekyll build

This runs the two commands one after the other: sass and then jekyll build.

To Preview the site locally and watch for changes:

$ jekyll serve --watch --baseurl= & sass --watch assets/stylesheets/:assets/stylesheets

This runs the two commands: jekyll serve and sass --watch.

Then open http://0.0.0.0:4000 in your browser. You will need to refresh the browser window to see changes.

Editing content

For developers

Layouts are a mixture of HTML and Liquid. Content is written in Markdown.

For site editors

Sign up for a Github account. Ask one of our developers to add you to the playbook project. Then use prose.io - when you first visit prose you will be asked to authorise access to your Github account.

More information on using prose can be found on their website and on the wiki page of their Github repo.

Deployment

Note: Don't forget to pull before you push!

Simply commit and push changes to the gh-pages branch to Github. Because Github Pages uses Jekyll to build its pages it will automatically build and publish the site for you, pretty much immediately.

$ git push origin gh-pages

Author

Matt Bailey

About

This site is all about how we work and make things, how we operate as a company.

http://playbook.gpmd.io/


Languages

Language:CSS 92.7%Language:HTML 4.7%Language:JavaScript 2.7%