For jekyll to generate the web-pages to be visible through a web-browser, your blog needs to live on the gh-pages
branch of your repository.
-
Create a gh-pages branch: To do this, enter the settings of your repo, launch the automatic page generator (under the "Github pages" heading), and click through to generate the default setting.
-
Pull this branch to your local copy of the repo. To do this you will need to issue the following on the terminal command line:
git pull upstream git checkout gh-pages git pull upstream gh-pages
at which point your directory should contain the auto-generated default content from Github's automatic page generator. We'll soon get rid of that.
-
Bootstrap your content from this repo: Delete the auto-generated content in this branch and copy over the content from this repository.
-
Edit the following:
about.md
: Describe the project_config.yml
: Set the configuration variables for your own blog._posts
: Use the first post in this repo as a template for creating your own posts.
-
Commit everything, push it and make your first pull request - you are off!
Note: When you make pull requests, don't forget that you will want to make pull requests against the
gh-pages
branch of your team repo, not themaster
branch. Github allows you to select the base repo, and the base branch from a dropdown menu that appears when you ask to make a pull request. -
Use branches and pull requests to add more posts and more content to the blog.
-
Customize! For ideas, inspiration and code, take a look at http://jekyllthemes.org/