This blog post documents the setup done to create Data Gallery Blog and instructions on how to create and add a new post.
Jekyll requires the Ruby language. If you have a Mac, you’ve most likely already got Ruby. To confirm if you have the required 1.9.3 or 2.0.0 version, open up the Terminal application, and run the command:
If you have older version, follow these instructions to install Ruby.
Bundler is a package manager that makes versioning Ruby software a lot easier if you’re going to be building GitHub Pages sites locally. You don’t have to use it, but it’s recommended and the instructions in this document assume that you are using Bundler.
gem install bundler
Create a file in your site’s repository called
Gemfile and add the line
gem 'github-pages' and run:
Creating new blog site
To create a new bog site, run:
jekyll new myproject
myproject will be the repo name and a directory name where the blog will be located. If you are using github project pages, it will also be a part of the url (https://username.github.io/project). If you want to use GitHub User or Organization pages, follow those instructions instead.
_posts directory, crate your content file in this format: ‘YYYY-MM-DD-your-title.md’.
Add the section about markdown & metadata.
Publishing on GitHub
Create a new repo called
myproject. Follow those instructions.
On a command line, inside “project” directory, run:
Next, create new branch called “gh-pages” by running those commands:
git branch gh-pages git checkout gh-pages
To check the current branch:
There is one more config file change that needs to be made to run the blog on GitHub Pages. Add those two lines to
url: https://username.github.io baseurl: project
If you are using custom domain names, then use this url line
url: "http://customomain.com" instead. In our case we are using
url: "http://openjerseycity.org/" baseurl: "/blog"
Finally, add and commit all changes to GitHub:
git add . git commit -m"your comment goes here" git push origin gh-pages
In your browser, view
https://username.github.io/project. In case of this project the url is http://openjerseycity.org/blog/.
Running Jekyll locally in GitHub Pages Environment
To run Jekyll in a way that matches the GitHub Pages build server, in the root of your repository (after switching to the gh-pages branch for project repositories), run Jekyll with Bundler:
bundle exec jekyll serve --baseurl ''
Running Jekyll locally (the classic way)
Inside the “project” directory:
jekyll build jekyll serve
In your browser, view http://localhost:4000.
_sites directory is generated by Pelican and can be deleted and regenerated at any time.