This tutorial shows how to put into place a personal website using Pillar, and automatically deploy it using GitHub Pages and Travis CI.
Before going forward, let's precise the context;
https://your_github_username.github.io
You don't know how to write a Pillar document, you have a cheatsheet at https://squarebarcketsassociates.github.io/Booklet-PublishingAPillarBooklet/CheatSheet.html. No GitHub account, have a look there. In this tutorial, you need a Travis account linked to your GitHub one. Then after creating your GitHub account, follow the first part of this to set up a linked Travis account.
Then you are here to build your personal website and access it via https://your_github_username.github.io
.
Let's explain our choices. With a GitHub account, you have some advantages or possibilities. One of these advantages is a free hosting service GitHub Pages provided via https://your_github_username.github.io
. And you can build other websites based on that url like https://your_github_username.github.io/myProject
. Read more about GitHub Pages.
The tutorial will go through these steps:
If you don't have Pillar installed, follow these command lines.
#clone latest Pillar version
#for SSH cloning
$ git clone git@github.com:pillar-markup/pillar.git -b dev-7
#for HTTPS cloning
$ git clone https://github.com/pillar-markup/pillar.git -b dev-7
$ cd pillar
#start installation process
$ ./scripts/build.sh
#add pillar command in the PATH environment variable
$ cd ..
$ mv pillar ~/.pillar
# update path in your .bashrc or .zshrc
$ export PILLAR_HOME="$HOME/.pillar/build"
$ export PATH="$PATH:$PILLAR_HOME"
One important thing here, is that you should name the repository as Your_github_username.github.io in order to have your website available and updated everytime you commit.
Let's proceed following these steps:
Your GitHub repository is now created and is empty (Just only a README.md file and .gitignore).
Now the repository is created, clone it to your local machine.
Choose a directory anywhere in your machine and clone your repository.
: this part means you have git command line tool installed. If not, follow this.
#SSH
$ git clone git@github.com:Your_github_username/Your_github_username.github.io.git
#HTTPS
$ git clone https://github.com/Your_github_username/Your_github_username.github.io.git
As you are building a website, you should install academic archetype.
$ cd Your_github_username.github.io
$ pillar archetype academic
The last command could generate errors.
book
is present under .pillar/archetypes
, if not re-run ./scripts/build.sh