Skip to content

Latest commit

 

History

History
executable file
·
28 lines (17 loc) · 1.61 KB

README.md

File metadata and controls

executable file
·
28 lines (17 loc) · 1.61 KB
Raw

Build Status

This is the Github Pages source code for the Socrata Developer Portal (currently deployed to http://dev.socrata.com.

Contributing

We love pull requests! If you'd like to contribute, feel free to fork this repo and send us pull requests.

Setting Up

The site is a fairly standard Jekyll site, but there are a few steps you'll want to make first to ensure that everything compiles properly:

  1. Make sure you have the gh-pages branch checked out: git checkout -b gh-pages origin/gh-pages
  2. Pull in the site templates and CSS/SASS, which come from submodules: git submodule update --init
  3. Make sure you have Ruby version installed. Check .ruby-version to see the preferred version.
  4. Make sure you have the jekyll RubyGem installed
  • Install the bundler gem and then install the gems from the Gemfile: gem install bundler && bundle
  1. Build the site and run the local server: jekyll serve --watch. To speed up page re-building you can disable plugins by running jekyll serve --watch --safe

You can now view your local server at http://localhost:4000 (unless you changed the port number).

Before Submitting

Before submitting, run make test to run the test suite and confirm that you haven't broken anything.

Modifying CSS/SASS

Site styling is controlled via css/local.sass and it's automatically regenerated by Github Pages with each push.