Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 3.22 KB

README.md

File metadata and controls

54 lines (36 loc) · 3.22 KB
Raw

TornikeO's Website

Best practices

Google PageSpeeg

Getting started

For more about how to use Jekyll, check out this tutorial. Why Jekyll? Read Andrej Karpathy's blog post!

Installation

Local setup

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 [email protected]:<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.

Deployment

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! ✨

For personal and organization webpages:

  1. Rename your repository to <your-github-username>.github.io or <your-github-orgname>.github.io.
  2. In _config.yml, set url to https://<your-github-username>.github.io and leave baseurl empty.
  3. Set up automatic deployment of your webpage (see instructions below).
  4. Make changes, commit, and push!
  5. After deployment, the webpage will become available at <your-github-username>.github.io.

For project pages:

  1. In _config.yml, set url to https://<your-github-username>.github.io and baseurl to /<your-repository-name>/.
  2. Set up automatic deployment of your webpage (see instructions below).
  3. Make changes, commit, and push!
  4. After deployment, the webpage will become available at <your-github-username>.github.io/<your-repository-name>/.

To enable automatic deployment:

  1. Click on Actions tab and Enable GitHub Actions; do not worry about creating any workflows as everything has already been set for you.
  2. Make any other changes to your webpage, commit, and push. This will automatically trigger the Deploy action.
  3. Wait for a few minutes and let the action complete. You can see the progress in the Actions tab. If completed successfully, in addition to the master branch, your repository should now have a newly built gh-pages branch.
  4. Finally, in the Settings of your repository, in the Pages section, set the branch to gh-pages (NOT to master). For more details, see Configuring a publishing source for your GitHub Pages site.