Skip to content
Switch branches/tags


Failed to load latest commit information.
Latest commit message
Commit time
Dec 28, 2020
Sep 6, 2021
Sep 6, 2021
Sep 6, 2021
Oct 21, 2019
Sep 6, 2021
Nov 4, 2019


Init hugo site

hugo new site mysite
cd mysite

Install the theme

git submodule add themes/github-style

Update the theme

If you just installed the theme, it is already in the latest version. If not, you can update using the below commands

cd themes/github-style
git pull

Then, you need to rename the previous posts folder to post

cd <you-project-folder>
mv content/posts content/post

Setup readme

hugo new
echo '`Hello World!`' > content/

Pin post

pin: true

Add new post

Hugo will create a post with draft: true, change it to false in order for it to show in the website.

hugo new post/

Limit display content

Approch 1: use summary

title: "title"
date: 2019-10-22T18:46:47+08:00
draft: false
summary: "The summary content"

Approch 2: use <!--more-->

Use <!--more--> to seperate content that will display in the posts page as abstraction and the rest of the content. This is different from summary, as summary will not appear in the post.

title: "title"
date: 2019-10-22T18:46:47+08:00
draft: false
abstraction show in the post page
other content

add last modified data

add to config.toml

lastmod = true

  lastmod = ["lastmod", ":fileModTime", ":default"]

Support LaTex

In you post add math: true to front matter

katex: math

Then the katex script will auto render the string enclosed be delimiters.

# replace ... with latex formula
display inline \\( ... \\)
display block $$ ... $$

latex example

config.toml example

baseURL = ""
languageCode = "zh-cn"
title = "MeiK's blog"
theme = "github-style"
googleAnalytics = "UA-123456-789"
pygmentsCodeFences = true
pygmentsUseClasses = true

  author = "MeiK"
  description = "In solitude, where we are least alone."
  github = "MeiK2333"
  facebook = "MeiK2333"
  twitter = "MeiK2333"
  linkedin = "MeiK2333"
  instagram = "MeiK2333"
  tumblr = "MeiK2333"
  email = ""
  url = ""
  keywords = "blog, google analytics"
  rss = true
  lastmod = true
  userStatusEmoji = "😀"
  favicon = "/images/github.png"
  location = "China"

    title = "Link"
    href = ""
    title = "Link2"
    href = ""
    icon = ""

  lastmod = ["lastmod", ":fileModTime", ":default"] example

There are various way to deploy to github, here is a link to official document.

Here is an sample. Note line 22 have env HUGO_ENV="production", makes sure googleAnalysis is loaded during production, but is not loaded when we are testing it in localhost.


if [ "`git status -s`" ]
    echo "The working directory is dirty. Please commit any pending changes."
    exit 1;

echo "Deleting old publication"
rm -rf public
mkdir public
git worktree prune
rm -rf .git/worktrees/public/

echo "Checking out gh-pages branch into public"
git worktree add -B gh-pages public origin/gh-pages

echo "Removing existing files"
rm -rf public/*

echo "Generating site"
env HUGO_ENV="production" hugo -t github-style

echo "Updating gh-pages branch"
cd public && git add --all && git commit -m "Publishing to gh-pages ("

#echo "Pushing to github"
#git push --all

Then you can verify the site is working and use git push --all to push the change to github. If you don't want to check again every time, you can uncomment the #git push --all in the script.