Skip to content

csuwebdev/csuwebdev.github.io

Repository files navigation

Chico State Web Dev and Design Club website Build Status

This site is generated with Jekyll and uses Travis CI for continuous integration and deployment. The master branch contains the built version of the site, and the jekyll branch contains the code.

Site structure

Posts and Collections

To add new content with Jekyll, you create a new file in the _posts folder. Content can be written in markdown or HTML. You can generate a new post by typing

$ rake new title="post title"

Assets

The site's assets (CoffeeScript/JavaScript and SASS/CSS) are in the _assets directory. For more information on how this works, refer here.

How to Contribute

We use the fork & pull model to accept new code into the project. If you aren't familiar with that workflow, Github's Using Pull Requests article is a great primer.

If you plan on contributing more than once and want to keep your fork up to date with this project we recommend checking out these guides on configuring a remote for a fork and syncing a fork.

  1. Fork it ( https://github.com/csuwebdev/csuwebdev.github.io/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

For information about the Markdown syntax, refer to this.

Running the site locally

You will need Ruby installed. Node.js is recommended but not required. On Windows, you should download Ruby 2.1.5 from here, and then download and install the development kit. On Windows, you need the wdm gem, which won't work on Ruby 2.2.0. Once you've installed Ruby, type the following at the command line.

$ gem install bundler
$ bundle
$ jekyll serve

Navigate to http://localhost:4000. The site will be automatically rebuilt whenever you edit a file.