It's been a while that I was wondering what could be a better way to improve my English communication and writing skills?
What about starting a technical blog?
I think in this way I could have fun, keep learning a lot of new stuff and improve my skills by actually practicing it, while building something of my own.
So here I am writing my first blog post on how I actually build this blog 🙂 Let's goooooooooo 💪
P.S: Sorry in advance for my rough English In this post I'll try to explain how to set up a personal site or blog with Hugo for free, by creating a continuous deployment workflow with GitHub Actions, deploying and hosting our site on Vercel platform.
A static site generator is a build tool that produces sites that have pages built beforehand and do not change often between user visits. Those pre-rendered pages are hosted where users can access them, a quite different approach unlike dynamic sites we're used to see where a page is built when a user requests it.
Static sites involve a lot fewer moving parts and are easier to build, secure, and maintain. They are fast since pages are already pre-rendered and are served as is. Scaling static sites is easier compared to other sites with more complex infrastructures. There are a lot of static sites generators, but here I'll list some of advantages/features that I found quite useful and for which I chose Hugo.
Fast & Flexible
Hugo is pretty flexible.
I started this blog with simple open source theme (there are a lot of them), then changed it completely over time. Sometimes I want to do things (e.g custom tracking, comments integration) in my website that are out of the scope of a simple blog, and Hugo allows to create those things.
Another reason I chose Hugo is because it is fast. First, it has Go at the core, which is known to be a fast compiled language. Also Go's Goroutines are a perfect match for many of the tasks that Hugo performs on every build. Things are made to be as fast as possible.
For example, it comes with Live Reload built in and every time changes are detected it takes milliseconds to see the result:
Change detected, rebuilding site. 2021-11-09 23:57:27.805 +0100 Source changed "path\\to\\post\\personal-website-with-hugo-and-vercel\\index.md": WRITE Total in 17 ms
I think hugo is a right choice for a technical blog, especially if you are a developer and you’re willing to write in Markdown. Non-tech people might just refuse to use Markdown, and it’s perfectly understandable.
Also, you have to be prepared for a Git-centric workflow for publishing your posts (or you can use some cms solutions like Strapi or Forestry). Most people would disagree with me on using
git commit and
git push just for publishing a post, but I found it pretty cool.
For example, my process for writing a new post is:
- Write a post using Markdown
- Commit my changes to a GitHub develop branch
- Some glue technology deploys the changes on the Vercel preview server
- Take some days to review the post in preview environment, make some improvements and then I am satisfied create a pull request towards the main branch
- After self-accepting the PR, the same glue technology deploys all new stuff on the main server visible to all the world
Here are some stuff that you're gonna need in order to make the magic happens:
- Git version control system installed
- Installation of Hugo version
- A free subscription of Vercel account
- A GitHub account
Step 1: Preparation
First of all, we need to check a correctness of Git installation in your system, just by running the
git version command on your terminal.
You should see something like this on your terminal, as an output:
git version 2.31.1.windows.1
If you don't have git, you can install it by downloading from the official website.
Make sure to connect Git with you GitHub account. Read more about GitHub and Git setup from here. Now we need to install Hugo:
1) Go to Hugo installation section of documentation and follow the steps for your operating system
... and create an empty repository in your GitHub account:
2) Create a new repository with the name you like (for this tutorial I'll be using
Now, you should be ready to go! 🎉
Step 2: Create your website
Creating a new site
Creating a website is pretty easy, just fire the command
hugo new site hugo-example-blog in a directory of your choice:
$ hugo new site hugo-example-blog Congratulations! Your new Hugo site is created in \path\to\hugo-example-blog.
Lets add a newly created project to our GitHub repository:
- In the command line, navigate to the newly created directory (/path/to/hugo-example-blog)
- Initialize the local directory as a Git repository:
$ git init -b main Initialized empty Git repository in /path/to/hugo-example-blog/.git/
- Stage and commit all the files in your project:
$ git add . $ git commit -m "Initial commit"
- Push all files to GitHub repository:
# add remote for the repo $ git remote add origin <REMOTE_URL> # sets the new remote $ git remote -v # for pulling unrelated remote history if there are conflicts $ git pull origin main --allow-unrelated-histories # push the changes to remote repository $ git push origin main
Adding the theme
We need to choose a theme for our website. You can do it by choosing the one you like from the official hugo site. Almost all the themes are open source so you can modify them freely.
For this example I've chosen a paper theme.
Now we need to "install" our theme on newly created website.
There are two ways to do that:
- Installing a theme as a Git submodule: particularly useful when you want to keep your theme updated with new features:
# navigate to the themes directory inside the site repository $ cd themes # add the theme as a submodule $ git submodule add <THEME_REMOTE_URL>
- Manually installing a theme: it's recommended when your are aware of making a lot of custom changes on the theme
If you do not have Git installed:
# navigate to the themes directory inside the site repository $ cd themes # clone the theme $ git clone <THEME_REMOTE_URL> <THEME_NAME>
- Download the .zip file from GitHub
- Unzip it to your site's themes directory
- Rename the directory to the theme name
Here the commands for installing as a submodule our paper theme:
$ cd themes $ git submodule add https://github.com/nanxiaobei/hugo-paper.git
Configuring and testing the website
- Copy a content of
themes/hugo-paper/exampleSitefolder to the root website folder
config.tomlfile based on your needs
- Start a website by firing
hugo serveron your terminal inside site folder
- Enjoy the result:
You can add a new pages or posts anytime by creating files inside
Step 3: Deploy your website
In this section we will setup a simple GitHub Actions workflow with
production (main) and
develop (develop) branches that will build and deploy our website on Vercel.
Vercel is a platform for frontend frameworks and static sites, built to integrate with your headless content, commerce, or database. It is easy to develop, preview, and ship delightful user experiences, where performance is the default.
In order to deploy our Hugo site from GitHub we need in some way give to GitHub Actions access to our Vercel account.
We're gonna need three essential values from Vercel:
- Vercel Account Token
- Organization ID
- Project ID
For generation a new Account Token just visit vercel.com/account/tokens and click on
create, give it a name (in my case 'hugo-example-site') and save it for later use.
To obtain a Organization ID and Project ID a new project needs to be created.
For this we’ll use the Vercel CLI.
Use either the
yarn package manager to install the Vercel CLI in your local development environment:
$ npm i -g vercel
Deploying to vercel
Now we create a new project on our vercel account:
- Login on vercel locally by firing
vercelcommand on the root of our project and following instructions:
$ vercel Vercel CLI 23.1.2 No existing credentials found. Please log in: Log in to Vercel github Success! GitHub authentication complete for email@example.com
- Now that you’re logged in run the
vercelcommand again to configure and deploy our site to Vercel as a new project:
$ vercel Vercel CLI 23.1.2 ? Set up and deploy “path\to\hugo-example-blog”? [Y/n] y ? Which scope do you want to deploy to? olich97 ? Link to existing project? [y/N] n ? What’s your project’s name? hugo-example-blog ? In which directory is your code located? ./ > Upload [===============-----] 72% 1.5sAuto-detected Project Settings (Hugo): - Build Command: `npm run build` or `hugo -D --gc` - Output Directory: `public` or `publishDir` from the `config` file - Development Command: hugo server -D -w -p $PORT ? Want to override the settings? [y/N] n 🔗 Linked to olich97/hugo-example-blog (created .vercel and added it to .gitignore) 🔍 Inspect: https://vercel.com/olich97/hugo-example-blog/ESNvEjydmACDsiibPJt2YCwrYyS9
Once deployed search the newly generated local
.vercel directory for the
project.json file, it’ll contain your new organisation and project IDs:
We need to configure our GitHub site repository with newly created secrets.
Go to GitHub site
repository > Settings > Secrets > Actions > New repository secret.
Add all three vercel values created:
Since GitHub Actions will be responsible for building Hugo site our new project settings need be updated so that Vercel doesn’t attempt to build the site again once GitHub Actions has pushed the content to Vercel.
In the Vercel dashboard navigate to the Settings of new project. Click the switch to override the BUILD COMMAND. Leave the input field empty:
Creating the GitHub Actions Workflow Files
First of all we need to create a
develop branch by running git checkout on the root of our hugo website:
$ git checkout -b develop Switched to a new branch 'develop'
.github/workflows directory at the root of our project create two new files:
Let push our changes on GitHub and see what happens.
$ git add . $ git commit -m "ci: add GitHub Actions workflow" $ git push --set-upstream origin develop
If we take a look on our GitHub project page we can see that a new environment was created:
Now we can view our preview deployment just by clicking on View deployment link inside GitHub Project deployments page:
As you can see vercel generate a temporary url for our deployment so we can check it:
Now we just have to release everything in production and it is pretty easy: just create and merge a new pull request against
GitHub Actions will build
main branch automatically and deploy to vercel production.
Now it could be navigated from free vercel domain assigned to our website: hugo-example-blog.vercel.app.
The domain can be customized on Vercel Project Settings page:
In this article we've created a new static website from zero and configured an automatic deployment workflows for two environments:
preview: for our testing purposes
production: for final users
Another advantage of using a static website (in this case build with Hugo) is pages load time (that is pretty fast in this case). You can check performance of our newly created website on GTmetrix and see it by yourself.
Complete Source Code: github.com/olich97/hugo-example-blog