A simple, clean, and responsive Jekyll theme for academics.
$ git clone [email protected]:<your-username>/<your-repo-name>.git
$ cd <your-repo-name>
Using Docker to install Jekyll and Ruby dependencies is the easiest way.
You need to take the following steps to get al-folio
up and running on your local machine:
- First, install docker and docker-compose.
- Finally, run the following command that will pull the latest pre-built image from DockerHub and will run your website.
$ docker compose pull
$ docker compose up
Note that when you run it for the first time, it will download a docker image of size 400MB or so.
Now, feel free to customize the theme however you like (don't forget to change the name!). After you are done, you can use the same command (docker compose up
) to render the webpage with all you changes. Also, make sure to commit your final changes.
To change port number, you can edit
docker-compose.yml
file.
Install RVM
(Ruby Package Manager) and using it, install ruby version 3.2.2, install bundler also using gem. Then, run -
$ bundle install
$ bundle exec jekyll serve --lsi
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.
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:
- The name of your repository MUST BE
<your-github-username>.github.io
or<your-github-orgname>.github.io
. - In
_config.yml
, seturl
tohttps://<your-github-username>.github.io
and leavebaseurl
empty. - Set up automatic deployment of your webpage (see instructions below).
- Make changes, commit, and push!
- After deployment, the webpage will become available at
<your-github-username>.github.io
.
To enable automatic deployment:
- Click on Actions tab and Enable GitHub Actions; do not worry about creating any workflows as everything has already been set for you.
- Go to Settings -> Actions -> General -> Workflow permissions, and give Read and write permissions to GitHub Actions
- Make any other changes to your webpage, commit, and push. This will automatically trigger the Deploy action.
- 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 builtgh-pages
branch. - Finally, in the Settings of your repository, in the Pages section, set the branch to
gh-pages
(NOT tomaster
). For more details, see Configuring a publishing source for your GitHub Pages site.
If you keep your site on another branch, open .github/workflows/deploy.yml
on the branch you keep your website on and change on->push->branches and on->pull_request->branches to the branch you keep your website on. This will trigger the action on pulls/pushes on that branch. The action will then deploy the website on the branch it was triggered from.
The theme is available as open source under the terms of the MIT License.
Originally, al-folio was based on the *folio theme (published by Lia Bogoev and under the MIT license). Since then, it got a full re-write of the styles and many additional cool features.