Written by Edd Turtle on makewithhugo.com
on

Create a New Hugo Project

☕  Ad-blocker? Consider buying me a coffee instead :)

You’ve got your great new idea! Now how to get started? If you’re using Hugo as the tool to build your website then this post should be for you.

We’ll be looking at how to create a new basic project and the first few tasks on a clean new site.

You’ll need Hugo installed first, if you don’t then take a look at our guide on installing it.

1. To Begin

Using the terminal or command prompt (what ever you decide to call it!), navigate to the directory where you keep your projects (I keep mine in ~/www/). Then run the command below, replacing myproject with what you are going to call your project.

1
Copy to Clipboard
hugo new site myproject

new hugo project in terminal

2. Setup

You have your new project created now. But if we try and run it with this:

1
Copy to Clipboard
cd myproject && hugo serve

You’ll get this error:

1
Copy to Clipboard
WARN 2021/04/10 16:43:32 found no layout file for "HTML" for kind "home": You should create a template file which matches Hugo Layouts Lookup Rules for this combination.

:( But it’s no problem, it’s just missing a theme.

We’ll need to get a theme setup, you can find many examples on the theme store. In our example, we’re going to use Anatole.

View Themes View The Anatole Theme

To install our theme:

1
2
Copy to Clipboard
# Optional step if your new project is not a git repo already
git init

1
Copy to Clipboard
git submodule add https://github.com/lxndrblz/anatole.git themes/anatole

Replace our config file, with the theme’s example (to help us know all the settings/options):

1
Copy to Clipboard
cp themes/anatole/exampleSite/config.toml config.toml

Now, if we try:

1
Copy to Clipboard
hugo serve

… and click the url in the output (a localhost address). We should be greeted by something like this:

new hugo project in terminal

There’s plenty more to be done in setting up a site, but those are the basics of creating a new project and getting it to run. Good luck!

#new #project #terminal #bash #setup #create #site #command #folder #server
Author Edd Turtle

Edd is a PHP and Go developer who enjoys blogging about his experiences, mostly about creating and coding new things he's working on and is a big beliver in open-source and Linux.

Tweet me! ☕   Buy me a Coffee

Related Posts

  • Migrate Wordpress to Hugo –
    Wordpress is a fantastically popular blogging platform, but judging by the fact you are here, you’re looking to move to Hugo (great choice!) The software we’ve used in the past to do this for us is called wordpress-to-hugo-exporter (does as it’s name suggests). This will essentially convert the database posts saved into markdown files which you can use in Hugo and with your theme of choice. View on Github How to It’s important to note this works as a Wordpress plugin, so if you can’t install plugins it may not work for you.
  • Deploy a Hugo site to Netlify –
    Netlify is a convenient hosting platform for staticly built sites, like those built with Hugo, as it offers fast and cheap delivery of HTML files. In this tutorial, we will quickly run through how you can take your site from your local computer and push it out to the world-wide web.
  • How to Install the Latest Version of Hugo –
    You can view the latest releases here. If you want some extras with it, explore the exended edition. The ’extended’ version includes SASS building, extra minfiying and resource processing. Ubuntu 20.04 & 22.04 For Debian-based linux distributions, like Ubuntu 20.04 (Focal) and Ubuntu 22.04 (Jammy), it’s often easiest to pick up the latest copy over on the Hugo github (under Releases). One reason for this is how quickly new versions come out, the versions inside package managers can become out-dated quickly.