long-hugo-doc | Hugo static site generator in one long page | Static Site Generator library

If this is your first time using Hugo and you've already installed Hugo on your machine, we recommend the quick start.
{{% note %}} This quick start uses macOS in the examples. For instructions about how to install Hugo on other operating systems, see install. You also need Git installed to run this tutorial. {{% /note %}}.
{{% note %}} Homebrew, a package manager for macOS, can be installed from brew.sh. See install if you are running Windows etc. {{% /note %}}.
{{% note %}} There is lots of talk about "Hugo being written in Go", but you don't need to install Go to enjoy Hugo. Just grab a precompiled binary! {{% /note %}}. Hugo is written in Go with support for multiple platforms. The latest release can be found at Hugo Releases.
macOS (Darwin) for x64, i386, and ARM architectures
Windows
Linux
FreeBSD
Go to the brew website, https://brew.sh/, and follow the directions there. The most important step is the installation from the command line:. {{< code file="install-brew.sh" >}} ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" {{< /code >}}.
When installing from the tarball, you have to decide if you're going to install the binary in /usr/local/bin or in your home directory. There are three camps on this:. All three locations will work for you. In the interest of brevity, this guide focuses on option #2.
Install it in /usr/local/bin so that all the users on your system have access to it. This is a good idea because it's a fairly standard place for executables. The downside is that you may need elevated privileges to put software into that location. Also, if there are multiple users on your system, they will all run the same version. Sometimes this can be an issue if you want to try out a new release.
Install it in ~/bin so that only you can execute it. This is a good idea because it's easy to do, easy to maintain, and doesn't require elevated privileges. The downside is that only you can run Hugo. If there are other users on your site, they have to maintain their own copies. That can lead to people running different versions. Of course, this does make it easier for you to experiment with different releases.
Install it in your Sites directory. This is not a bad idea if you have only one site that you're building. It keeps every thing in a single place. If you want to try out new releases, you can make a copy of the entire site and update the Hugo executable.
Open https://github.com/gohugoio/hugo/releases in your browser.
Find the current release by scrolling down and looking for the green tag that reads "Latest Release."
Download the current tarball for the Mac. The name will be something like hugo_X.Y_osx-64bit.tgz, where X.YY is the release number.
By default, the tarball will be saved to your ~/Downloads directory. If you choose to use a different location, you'll need to change that in the following steps.
If you want to compile Hugo yourself, you'll need to install Go (aka Golang). You can install Go directly from the Go website or via Homebrew using the following command:.
You'll need a place to store the Hugo executable, your content, and the generated Hugo website:.
Open Windows Explorer.
Create a new folder: C:\Hugo, assuming you want Hugo on your C drive, although this can go anywhere
Create a subfolder in the Hugo folder: C:\Hugo\bin
Create another subfolder in Hugo: C:\Hugo\Sites
@dhersam has created a nice video on common issues:. {{< youtube c8fJIRNChmU >}}.
Upgrading Hugo is as easy as downloading and replacing the executable you’ve placed in your PATH.
The Hugo executable has one optional external dependency for source code highlighting (Pygments). If you want to have source code highlighting using the highlight shortcode, you need to install the Python-based Pygments program. The procedure is outlined on the Pygments homepage.
Once you have installed Hugo, make sure it is in your PATH. You can test that Hugo has been installed correctly via the help command:.
{{% note "No Default Theme" %}} Hugo currently doesn’t ship with a “default” theme. This decision is intentional. We leave it up to you to decide which theme best suits your Hugo project. {{% /note %}}.
The community-contributed themes featured on themes.gohugo.io are hosted in a [centralized GitHub repository][themesrepo]. The Hugo Themes Repo at https://github.com/gohugoio/hugoThemes is really a meta repository that contains pointers to a set of contributed themes. {{% warning "Get git First" %}} Without Git installed on your computer, none of the following theme instructions will work. Git tutorials are beyond the scope of the Hugo docs, but GitHub and codecademy offer free, interactive courses for beginners. {{% /warning %}}.
You can install all available Hugo themes by cloning the entire [Hugo Theme repository on GitHub][themesrepo] from within your working directory. Depending on your internet connection the download of all themes might take a while. Before you use a theme, remove the .git folder in that theme's root folder. Otherwise, this will cause problem if you deploy using Git.
Change into the themes directory and download a theme by replacing URL_TO_THEME with the URL of the theme repository:.
The .Paginator contains enough information to build a paginator interface.