gh-dataset-pages

Create a hosted GitHub/Jekyll website for a GitHub data repository with proper schema.org dataset SEO markup

Create Website

First cd to your data repository on your local computer

cd ~/my-data-repo

Now create a new branch called gh-pages

git checkout -b gh-pages

Pull the latest release for this repository, unzip, extract the template and cleanup. Copy and paste entire code block below.

wget https://github.com/ucd-library/gh-dataset-pages/archive/master.zip && \
  unzip master.zip && \
  cp -r gh-dataset-pages-master/template/* . && \
  cp -r gh-dataset-pages-master/template/.gitignore . && \
  rm -rf master.zip gh-dataset-pages-master

Edit the _config.yml file properties under the section Fill out dataset variables below

author:
  name: 
  email: 
keywords:
  - 
genre:
publisher:
  name: 
  url: 
  description: 
datePublished: 

Edit the index.md file and add content for your website.

You can test the site locally by installing and running Jekyll. Note: Ruby/gem required.

gem install jekyll bundler
bundle exec jekyll serve

Now visit http://localhost:4000 in your browser.

Commit and push new branch to GitHub and set upstream tracking

git add --all
git commit -m "initial commit of gh-pages website"
git push --set-upstream origin gh-pages

Visit your new dataset website host by GitHub!

https://[[org/username]].github.io/[[respositoryName]]/