Note: This tutorial assumes that you are using Hugo for the first time . Hugo is one of the most popular open-source static site generators. You can check the Hugo Official Docs for more help.
1. Install Hugo
Download the appropriate version for your platform from Hugo Releases. Once downloaded, the binary can be run from anywhere. Ideally, you should install it somewhere in your PATH for easy use. /usr/local/bin is the most probable location.
2. Create a New Site
hugo new site myBlog
The above will create a new Hugo site in a folder named myBlog.
3. Use Hugo-Theme-Jane
Clone this repository into themes folder:
git clone https://github.com/xianmin/hugo-theme-jane.git --depth=1 themes/jane
Copy the example site content:
cp -r themes/jane/exampleSite/content ./
Copy the default site config:
cp themes/jane/exampleSite/config.toml ./
Take a look at the example site:
Open http://localhost:1313/ , you will see your site running with the example content.
4. Start a Blog
The default config file config.toml is located in your site root directory. You can customize it to match the details of your site. Documentation about configuring Hugo can be found in the Official Documentation
The default content files are located in the ./content/post directory.
5. Generate Your Website
Run hugo , this generates your website to the public/ directory by default.
This directory contains an example config file and the content for the demo.
It serves as an example setup for you to configure to your liking.
Copy the config.toml to the root directory of your website. Overwrite the existing config file if necessary.
Single Post Configuration
Front Matter : Hugo allows you to add front matter in yaml, toml, or json to your content files.
# Common-Definedtitle: "An Example Post"date: 2018-01-01T16:01:23+08:00lastmod: 2018-01-02T16:01:23+08:00draft: falsetags: ["tag-1", "tag-2", "tag-3"]
author: "xianmin"# User-Defined# You can close(false) or open(true) something for this content.# P.S. comment can only be closedcomment: falsetoc: false# You can also define another contentCopyrightcontentCopyright: '<a rel="license noopener" href="https://creativecommons.org/licenses/by-nc-nd/4.0/" target="_blank">CC BY-NC-ND 4.0</a>'reward: falsemathjax: true
Multilingual (Language) Support
Hugo-Theme-Jane supports the creation of websites with multiple languages side by side.
You should define the available languages in a languages section in your site configuration.
Translations are collected from the i18n/ folder.
To use the translations:
# use Chinese translationdefaultContentLanguage = "zh-cn"# Default language to use (if you setup multilingual support)
languageCode = "zh-cn"