aerispaha/phila_political

Philadelphia political boundary viewer

Personal Website

This repo contains the stuff making up my personal site.

Current Setup

• hosted with GitHub Pages
• uses Jekyll with the Hyde theme based on Poole

Development Workflow

Jekyll is a static site generator. With that in mind, you need to build the static files anytime you want to make change.

Making a Post

Write the post content in a markdown file in the _posts directory. The publish date and title should be stored in the markdown filename; for example 2016-12-14-file-permissions-for-django-media-uploads.md.

When your satisfied with that beautiful prose, we can build the static files with Jekyll. Because we have a Gemfile, we need to build like this:

bundle exec jekyll serve

This should start a local server on which we can view the changes:

Configuration file: /home/adam/projects/aerispaha.github.io/_config.yml
            Source: /home/adam/projects/aerispaha.github.io
       Destination: /home/adam/projects/aerispaha.github.io/_site
 Incremental build: disabled. Enable with --incremental
      Generating...
       Jekyll Feed: Generating feed for posts
                    done in 0.316 seconds.
 Auto-regeneration: enabled for '/home/adam/projects/aerispaha.github.io'
    Server address: http://127.0.0.1:4000/
  Server running... press ctrl-c to stop.

When all looks good, we can publish the changes by merging the static file changes into the master branch (the branch configured in Github to host the GH pages content)

phila_political's Issues

Create README

Create a project readme helping to explain what this project is about. Can use language from the project proposal.

Organize GH project structure

Currently, the project is awkwardly contained in a doc/ directory, with Django source code and a ipython notebook adjacent. Rearrange this to make more sense.