For more about how to use Jekyll, check out this tutorial. Why Jekyll? Read Andrej Karpathy’s blog post!
Assuming you have Ruby and Bundler installed on your system (hint: for ease of managing ruby gems, consider using rbenv), first fork the theme from github.com:alshedivat/al-folio
to github.com:<your-username>/<your-repo-name>
and do the following:
$ git clone git@github.com:<your-username>/<your-repo-name>.git
$ cd <your-repo-name>
$ bundle install
$ bundle exec jekyll serve
Now, feel free to customize the theme however you like (don’t forget to change the name!). After you are done, commit your final changes.
Deploying your website to GitHub Pages is the most popular option. Starting version v0.3.5, al-folio will automatically re-deploy your webpage each time you push new changes to your repository! :sparkles:
For project pages (default):
<your-github-username>.github.io/<your-repository-name>/
.master
branch should be used for the source code of your webpage and gh-pages
branch (will be created on the first deployment) will be used for deployment.For personal and organization webpages:
<your-github-username>.github.io
or <your-github-orgname>.github.io
.master
to source
. From now on, this will be your default branch. Any changes you make should be committed and pushed to this branch.url
and baseurl
fields in _config.yml
are empty.source
branch, your repository should now have a newly built master
branch.master
(NOT to source
).NOTE: you must do all your changes in the source
branch (the one you used to push) NOT the master one; this last one is used for deploying by Github Pages and it is not suitable for pushing changes.