Use this guide if you are just getting started with Git (for forking, cloning, committing and pushing changes), Github Pages and/or Jekyll. If you are already familiar with these tools, instead use the Type Theme documentation.
Step 1: Get your theme running online
In this step, we’ll publish a blog on Github Pages which allows free hosting from Github repositories and runs Jekyll.
First, visit the Type Theme repository on Github, and use the “fork” button to create your own copy of the theme.
Next, rename your repository by clicking the “settings” button in your newly created repository.
Rename the repository to
username.github.io (replacing “username” with your Github username) to use Github Pages to host your Jekyll website.
Visit https://username.github.io (again replacing “username” with your Github username) to see your Jekyll website live!
Step 2: Install Jekyll and Git
Skip this step if you already have Jekyll and Git installed.
If you are running Linux or Mac OSX, visit the Jekyll docs for instructions on installing Jekyll. If you’re running Windows visit Julian Thilo’s instructions for installing Jekyll on Windows as there are a few extra steps.
Also install Git, you may already have Git installed so in Terminal/Bash/Command Prompt type
git --version to check if Git returns a version number. If not, visit the Git downloads page and install Git.
Step 3: Cloning your repository
Create a copy of the repository on your computer by cloning.
To clone, in Terminal/Bash/Command Prompt type (replacing “username” with your own):
git clone https://github.com/username/username.github.io.git
Alternatively, if you’re using a GUI, make use of the ‘clone’ feature. Here’s what that process in Github for Windows looks like (after signing in and clicking the add button):
Step 4: Your first post
_posts folder and make new file called “2015-01-01-my-first-post.md”. Inside type the contents of your first post.
--- layout: post title: My first post --- Just testing posts in Jekyll
In Jekyll, posts use a variant of Markdown for formatting of text.
To see your changes locally:
- Save your new post
- Run the Jekyll server by typing
jekyll servein Terminal/Bash/Command Prompt
- Visit http://localhost:4000 in your browser to view the site
Your new post should be visible on the front page of the theme.
Step 5: Saving and sharing changes
Once you’re happy with your new post, you can commit changes using Terminal/Bash/Command Prompt and push changes to make them public:
- Add the new files to be tracked, by typing
git add *.md
- Commit changes, by typing
git commit -m 'add my first post'
- Push changes to the web, by typing
git push origin master
- Visit https://username.github.io to see your changes live
Here’s what steps 1 to 3 look like in Github for Windows:
Step 1 and Step 2: Adding files to the commit with a title
Step 3: Syncing in Github for Windows pushes changes to the repository online.
Step 5: Customising Type Theme
Now that you’ve got Type Theme running, know how to make posts, can preview Jekyll websites locally using
jekyll serve, and save changes using “git push” or syncing in the GUI, you will want to make some finishing touches to customise the theme.
The most important changes to make are to:
- update the site configuration in
_config.ymlto match the URL your Jekyll website is hosted on (such as
- update your title in
_config.ymlto rename your Jekyll blog, and to
- update social icons to match your own usernames.
All the above changes are made by opening the
_config.yml file in a text editor. Please visit the Type Theme documentation for the complete details on customising the theme with examples of configuration.