Hugo Static Site

Getting Started

First, we'll need to install Hugo.

macOS

brew install hugo

(If you aren't using brew, get it here)

debian / ubuntu

sudo apt-get install hugo

other platforms

See the Hugo Website

Next, let's clone the example project

git clone https://github.com/ronakdev/hugo-project/
cd hugo-project

Now, we simply need to install and run the project!

npm install
npm start

Note how npm install runs pullzesty

The example project's package.json also comes pre-equipped with some handy utility commands.

• npm start # rebuilds data from zesty.io and runs a hugo server
• npm run-script build-hugo # rebuilds data from zesty.io and runs hugo to build a folder in docs/
• npm run-script all # rebuilds data from zesty.io, runs hugo to build a folder in docs/, and runs a hugo server

Understanding the Example Project

Hugo provides support for front-matter, which PullZesty takes advantage of to create the files. The real magic in this project lies in the zesty.yaml file, which specifies the proper paths for all of our content. This content is merely consumed by some layouts. When creating your own Hugo project, feel free to look at our zesty.yaml file and our layout files.

{{ define "content" }}
<div data-spy="scroll" data-target="#site-navbar" data-offset="200">
    <section class="site-cover" style="background-image: url({{ with .Params.splash_background }}{{ . | safeHTML }}{{ end }});" id="section-home">
        <div class="container">
            <div class="row align-items-center justify-content-center text-center site-vh-100">
                <div class="col-md-12">
                    <h1 class="site-heading no-site-animate mb-3">{{ with .Params.splash_title }}{{ . | safeHTML }}{{ end }}</h1>
                    <h2 class="h5 site-subheading mb-5 no-site-animate">{{ with .Params.splash_description }}{{ . | safeHTML }}{{ end }}</h2>
                    <p><a href="{{ with .Params.splash_link }}{{ . | safeHTML }}{{ end }}" target="_blank" class="btn btn-outline-white btn-lg no-site-animate" data-toggle="modal" data-target="#reservationModal">{{ with .Params.splash_link_text }}{{ . | safeHTML }}{{ end }}</a></p>
                </div>
            </div>
        </div>
    </section>
</div>
{{ end }}

As you can see in our index.html file, we simply load in the front-matter from the content/_index.md file.