hugo/docs/content/en/hosting-and-deployment/hosting-on-netlify/index.md
2024-11-13 11:07:57 +01:00

3.7 KiB

title description categories keywords menu toc
Host on Netlify Host your site on Netlify with continuous deployment.
hosting and deployment
hosting
docs
parent
hosting-and-deployment
true

Prerequisites

  1. Create a Netlify account
  2. Install Git
  3. Create a Hugo site and test it locally with hugo server
  4. Commit the changes to your local repository
  5. Push the local repository to your GitHub, GitLab, or Bitbucket account

Procedure

This procedure will enable continuous deployment from a GitHub repository. The procedure is essentially the same if you are using GitLab or Bitbucket.

Step 1
Log in to your Netlify account, navigate to the Sites page, press the Add new site button, and choose "Import an existing project" from the dropdown menu.
Step 2
Select your deployment method.

screen capture

Step 3
Authorize Netlify to connect with your GitHub account by pressing the Authorize Netlify button.

screen capture

Step 4
Press the Configure Netlify on GitHub button.

screen capture

Step 5
Install the Netlify app by selecting your GitHub account.

screen capture

Step 6
Press the Install button.

screen capture

Step 7
Click on the site's repository from the list.

screen capture

Step 8
Set the site name and branch from which to deploy.

screen capture

Step 9
Define the build settings, press the Add environment variables button, then press the New variable button.

screen capture

Step 10
Create a new environment variable named HUGO_VERSION and set the value to the latest version.

screen capture

Step 11
Press the "Deploy my new site" button at the bottom of the page.

screen capture

Step 12
At the bottom of the screen, wait for the deploy to complete, then click on the deploy log entry.

screen capture

Step 13
Press the Open production deploy button to view the live site.

screen capture

Configuration file

In the procedure above we configured our site using the Netlify user interface. Most site owners find it easier to use a configuration file checked into source control.

Create a new file named netlify.toml in the root of your project directory. In its simplest form, the configuration file might look like this:

{{< code file=netlify.toml >}} [build.environment] HUGO_VERSION = "0.137.1" TZ = "America/Los_Angeles"

[build] publish = "public" command = "hugo --gc --minify" {{< /code >}}

If your site requires Dart Sass to transpile Sass to CSS, the configuration file should look something like this:

{{< code file=netlify.toml >}} [build.environment] HUGO_VERSION = "0.137.1" DART_SASS_VERSION = "1.80.6" TZ = "America/Los_Angeles"

[build] publish = "public" command = """
curl -LJO https://github.com/sass/dart-sass/releases/download/${DART_SASS_VERSION}/dart-sass-${DART_SASS_VERSION}-linux-x64.tar.gz &&
tar -xf dart-sass-${DART_SASS_VERSION}-linux-x64.tar.gz &&
rm dart-sass-${DART_SASS_VERSION}-linux-x64.tar.gz &&
export PATH=/opt/build/repo/dart-sass:$PATH &&
hugo --gc --minify
""" {{< /code >}}