Spider Themes Helpdesk Spider Themes Helpdesk
  • Home 
  • Forums 
    • Docy – WordPress Theme 
    • Banca WordPress Theme 
    • Landpagy WordPress Theme 
  • Docs 
    • Docy WordPress Theme 
    • Docy Jekyll Theme 
    • Banca WordPress Theme 
    • Landpagy WordPress Theme 
  • Blog 
Spider Themes Helpdesk Spider Themes Helpdesk
Spider Themes Helpdesk
  • Home 
  • Forums 
    • Docy – WordPress Theme 
    • Banca WordPress Theme 
    • Landpagy WordPress Theme 
  • Docs 
    • Docy WordPress Theme 
    • Docy Jekyll Theme 
    • Banca WordPress Theme 
    • Landpagy WordPress Theme 
  • Blog 

Docy Jekyll Theme

  • folder icon closed folder iconGetting Started
    • Theme Installation
    • Basic Theme Setup
    • Creating your first post in Jekyll
    • Creating docs posts
  • folder icon closed folder iconManage Contents
    • Navigation Bar
    • Footer Options
    • Docy Testimonial
    • Enabling comments (via Disqus)
    • Recommended Topics
    • Google Analytics
  • folder icon closed folder iconDeployment
    • Github
    • Netlify
loading
  1. Home
  2. Docy Jekyll Theme
  3. Deployment
  4. Github
Updated on November 24, 2021

Docy Jekyll Theme

  • folder icon closed folder iconGetting Started
    • Theme Installation
    • Basic Theme Setup
    • Creating your first post in Jekyll
    • Creating docs posts
  • folder icon closed folder iconManage Contents
    • Navigation Bar
    • Footer Options
    • Docy Testimonial
    • Enabling comments (via Disqus)
    • Recommended Topics
    • Google Analytics
  • folder icon closed folder iconDeployment
    • Github
    • Netlify

Github

Estimated reading: 2 minutes 53 views

Set up your github repo

  1. Make sure you have Git installed. You can download and install Git for Windows here and Git for Mac here. If you’re on a Mac, chances are you might already have git installed. You can check by opening up a terminal and typing which git.
  2. Go to Github.com and sign up for an account.
  3. Click the + button in the upper-right corner and select New repository.
  4. Name the repository something like mydoctheme.
  5. Type a description..
  6. Select the Initialize this repository with a README check box.
  7. Add a license if desired.
  8. Leave the other options at the defaults and click Create repository.
  9. Click the Settings button.
  10. Go to your repository’s home page, and click the branch drop-down menu.
  11. Create a new branch called gh-pages.
  12. Click Settings and change the default branch to gh-pages
  13. Go back to your repository’s homepage. With the gh-pages branch selected, copy the https clone url:
  14. Open a terminal, browse to a convenient location for your project, and type git clone https://github.com/tomjoht/myreponame.git, replacing the https://github.com/tomjoht/myreponame.git with your repository’s https clone URL that you copied.
  15. Move the jekyll theme files into this new folder that you just created in the previous step.
  16. Open the _config.yml file and add the following:
 url: tomjoht.github.io
 baseurl: /myreponame

Change the url to your github account name, and the baseurl to your repo name.

Install Bundler

Bundler is a package manager for Ruby that will install all dependencies you might need to build your site locally.

gem install bundler

Add the github pages gem

  • In terminal, browse to your Jekyll project directory.
  • Type bundle init. This creates a Gemfile and Gemfile.lock in your project.
  • Type open gemfile. This opens the gemfile in your default text editor.
  • Add the following in the gemfile (replacing the existing contents):
source 'https://rubygems.org'
gem 'github-pages'
  • Run bundle install.
  • Add the new jekyll files to git: git add --all.
  • Commit the files: git commit -m "committing my jekyll theme".
  • Push the files up to your github repo: git push.

Github Pages will now automatically build your site. Wait a minute or two, and then visit tomjoht.github.io/yourreponame, replacing this path with your github account and branch

Still stuck? How can we help?

How can we help?

A premium WordPress theme with integrated Knowledge Base, providing 24/7 community based support.

Was this page helpful? Yes No

Leave a Comment Cancel reply

CONTENTS

Powered By EazyDocs

Leaf Illustration

This website is made with Docy