Skip to content

geopython/pywps.org

Repository files navigation

Build Status

pywps.org

This is the setup for https://pywps.org

Prerequisites

The tools used to compile this website relly on Ruby version 2.0 or greater. Make sure you have it installed before starting. On Ubuntu you can install the necessary Rauby packages in the following way:

sudo apt-add-repository ppa:brightbox/ruby-ng
sudo apt-get update
sudo apt-get install ruby2.2 ruby2.2-dev

Setting up website environment locally

# setup virtualenv
virtualenv pywps.org && cd $_
. bin/activate
# get the repo
git clone [email protected]:geopython/pywps.org.git && cd pywps.org
# set Ruby environment variables
. setenv-ruby-gem
# install Jekyll
gem install ffi jekyll link-checker jekyll-mentions jekyll-sitemap github-pages

Workflow

# edit / verify content

jekyll build
jekyll serve  # default port is 4000, set explicitly with -P.  On dev use -b /pywps.org to set proper local url
# commit and push
git commit -m 'update website'
git push origin gh-pages
# check links
check-links _site
# view at http://localhost:4000
# adding blogposts
cd _drafts
vi newpost.md
# make sure to set the following YAML front matter:
# layout: post
# title: Some Title
# author: Firstname Lastname
# author_url: URL to link to the author (Twitter, GitHub, etc.)
# preview with `make drafts` and draft will show up as latest post
# when you are ready to publish:
# - rename the file as per the current YYYY-MM-DD
git mv _drafts/newpost.md _posts/YYYY-MM-DD-newpost.md
vi _posts/YYYY-MM-DD-newpost.md
# update the publish_date YAML front matter
# commit and push
git commit -m 'publish article'
git push origin gh-pages

For a Sphinx feel, there's a Makefile with the familiar targets:

make html
make linkcheck
make clean
make drafts

Minimal Theme

pywps.org uses the Minimal Theme from GitHub Pages.

Syntax highlighting is provided on GitHub Pages by Pygments.