diff options
| -rw-r--r-- | web/tutorials/github-pages-tutorial.md | 67 |
1 files changed, 30 insertions, 37 deletions
diff --git a/web/tutorials/github-pages-tutorial.md b/web/tutorials/github-pages-tutorial.md index 5e5c104..f81c593 100644 --- a/web/tutorials/github-pages-tutorial.md +++ b/web/tutorials/github-pages-tutorial.md @@ -1,5 +1,16 @@ ## Using Hakyll with GitHub Pages +[GitHub Pages](http://pages.github.com) has become a popular static website hosting solution due to its simplicity. Simply push a couple files to a repository and it's off to the races. + +Working with Hakyll on a GitHub Pages-hosted website is complicated slightly due to Hakyll outputting files to a ```_site``` subdirectory, our desire to have the source code as well as the compiled site stored in a single repository, and our desire to automate it. + +This guide will walkthrough the creation and setup of a GitHub site that has two independent branches. + +1. ```master``` - This is where your site lives. It's what you see when you go to ```https://<your repo>.github.io```. This branch *needs* to be called master. +2. ```develop``` - This is where your website's source is. That's all your Haskell code, your posts and templates, etc, and it's where you do work from. This name was chosen arbitrarily and can be freely substituted for any name of your choosing. + +When you're finished, you will be able to, with one command, refresh your website's contents and send any changes to your GitHub Page. + In the interest of keeping this guide as simple as possible, I'll be making a few assumptions. 1. Haskell is being used with [Stack](http://docs.haskellstack.org/en/stable/README/). @@ -50,11 +61,15 @@ So everything's all setup and we're ready to deploy. Temporarily save any uncommitted changes that may exist in the current branch. -```git stash``` +``` +git stash +``` Ensure we are in the correct branch. -```git checkout develop``` +``` +git checkout develop +``` Get a clean build of our site. @@ -65,15 +80,21 @@ stack exec myblog build Update the local list of remote branches to ensure we're able to checkout the branch we want in the next step. -```git fetch -all``` +``` +git fetch -all +``` Switches to a new branch called "publish" that tracks the origin "master" branch. **Note:** Checking out the publish branch does not overwrite the files that Hakyll just produced because we have '_site' in both .gitignore files. -```git checkout -b publish --track origin/master``` +``` +git checkout -b publish --track origin/master +``` Copy the freshly made contents of '_site' over the old ones. Note that if a file is *no longer* being produced (for example if you deleted a blog posting), it will continue to persist in your published site until it's been removed from that repository as well. -```cp -a _site/. .``` +``` +cp -a _site/. . +``` Commit our changes. @@ -84,7 +105,9 @@ git commit -m "publish." And send them to GitHub. -```git push origin publish:master``` +``` +git push origin publish:master +``` Final clean up and return to the original state. @@ -96,35 +119,5 @@ git stash pop ### *And that's it.* -Here is a full listing of the script. +A full listing of the "script" is available [here](https://gist.github.com/narrative/5edb976b2f8754a79104). -``` -# Temporarily store uncommited changes -git stash - -# Verify correct branch -git checkout develop - -# Build new files -stack exec myblog clean -stack exec myblog build - -# Get previous files -git fetch -all -git checkout -b publish --track origin/master - -# Overwrite existing files with new files -cp -a _site/. . - -# Commit -git add -A -git commit -m "publish." - -# Push -git push origin publish:master - -# Restoration -git checkout develop -git branch -D publish -git stash pop -``` |