hextra/exampleSite/content/docs/getting-started.md

title	weight	next	prev
Getting Started	1	/docs/guide	/docs

Quick Start from Template

{{< icon "github" >}} imfing/hextra-starter-template

You will be able to quickly get started by using the above template repository.

We have provided a GitHub Actions workflow which can help automatically build and deploy your site to GitHub Pages, and host it for free.

🌐 Demo ↗

Start as New Project

Prerequisites

Before we start, make sure we have Hugo installed. Please refer to Hugo's official installation guide for more details.

Hugo modules are the recommended way to manage Hugo themes. To use Hugo modules, we need to install Git and Go.

{{% steps %}}

Initialize a new Hugo site

$ hugo new site my-site --format=yaml

Configure Hextra theme via module

# initialize hugo module
$ cd my-site
$ hugo mod init github.com/username/my-site

# add Hextra theme
$ hugo mod get github.com/imfing/hextra

Edit hugo.yaml to enable Hextra theme:

module:
  imports:
    - path: github.com/imfing/hextra

Create your first content pages

Let's create a new content page for the home page and the documentation page:

$ hugo new content/_index.md
$ hugo new content/docs/_index.md

Preview the site locally

$ hugo server --buildDrafts --disableFastRender

Voila! You can see your new site at http://localhost:1313/.

{{% /steps %}}

Update Theme

{{% details title="How to update theme?" %}}

To update the theme to the latest released version, run the following command:

$ hugo mod get -u

See Hugo Modules for more details.

{{% /details %}}

Next

Explore the following sections to start adding more contents:

{{< cards >}} {{< card link="../guide/organize-files" title="Organize Files" icon="document-duplicate" >}} {{< card link="../guide/configuration" title="Configuration" icon="adjustments" >}} {{< card link="../guide/markdown" title="Markdown" icon="markdown" >}} {{< /cards >}}