mirror of
https://github.com/gohugoio/hugo.git
synced 2024-12-23 14:33:03 +00:00
Merge commit 'da16527896d3087585c5e758083ea498dcabc2c3'
This commit is contained in:
commit
ef518485ce
38 changed files with 372 additions and 174 deletions
|
@ -1,7 +1,8 @@
|
|||
var docsearch = require('docsearch.js/dist/cdn/docsearch.js');
|
||||
docsearch({
|
||||
apiKey: '167e7998590aebda7f9fedcf86bc4a55',
|
||||
indexName: 'hugodocs',
|
||||
inputSelector: '#search-input',
|
||||
debug: true // Set debug to true if you want to inspect the dropdown
|
||||
appId: 'D1BPLZHGYQ',
|
||||
apiKey: '6df94e1e5d55d258c56f60d974d10314',
|
||||
indexName: 'hugodocs',
|
||||
inputSelector: '#search-input',
|
||||
debug: true, // Set debug to true if you want to inspect the dropdown
|
||||
});
|
||||
|
|
File diff suppressed because one or more lines are too long
|
@ -41,7 +41,7 @@
|
|||
|
||||
<img src="/images/gopher-side_color.svg" alt="" class="absolute-l bottom-0 dn db-l h4 right-0 z-999"/>
|
||||
|
||||
<div class="bg-primary-color-dark bottom-0 left-0 right-0 dn-l fixed pb3 ph3 pt3 w-100">
|
||||
<div class="bg-primary-color-dark bottom-0 left-0 right-0 dn-l fixed pb3 ph3 pt3 w-100 z-2">
|
||||
{{- partial "nav-mobile.html" . -}}
|
||||
</div>
|
||||
|
||||
|
|
|
@ -1 +1 @@
|
|||
# github.com/gohugoio/gohugoioTheme v0.0.0-20221116211530-5ae8dcdd68d6
|
||||
# github.com/gohugoio/gohugoioTheme v0.0.0-20221124154621-1451a01f406b
|
||||
|
|
|
@ -1,16 +1,12 @@
|
|||
---
|
||||
linktitle: ""
|
||||
description: ""
|
||||
publishdate: ""
|
||||
lastmod: ""
|
||||
categories: [functions]
|
||||
tags: []
|
||||
ns: ""
|
||||
signature: []
|
||||
workson: []
|
||||
hugoversion: ""
|
||||
aliases: []
|
||||
relatedfuncs: []
|
||||
toc: false
|
||||
deprecated: false
|
||||
---
|
||||
|
|
|
@ -368,7 +368,7 @@ In case you need to pass a custom data: (`(dict "Count" numeric_value_only)` is
|
|||
The following localization examples assume your site's primary language is English, with translations to French and German.
|
||||
|
||||
{{< code-toggle file="config" >}}
|
||||
defaultContentLang = 'en'
|
||||
defaultContentLanguage = 'en'
|
||||
|
||||
[languages]
|
||||
[languages.en]
|
||||
|
@ -568,7 +568,19 @@ If there is more than one language defined, the `LanguagePrefix` variable will e
|
|||
|
||||
## Generate multilingual content with `hugo new`
|
||||
|
||||
Currently, `hugo new` is not ready to support generating multilingual content. But there is a [proposal topic](https://github.com/gohugoio/hugo/issues/7732) about this in GitHub issue to discuss how it should work.
|
||||
If you organize content with translations in the same directory:
|
||||
|
||||
```text
|
||||
hugo new post/test.en.md
|
||||
hugo new post/test.de.md
|
||||
```
|
||||
|
||||
If you organize content with translations in different directories:
|
||||
|
||||
```text
|
||||
hugo new content/en/post/test.md
|
||||
hugo new content/de/post/test.md
|
||||
```
|
||||
|
||||
[abslangurl]: /functions/abslangurl
|
||||
[config]: /getting-started/configuration/
|
||||
|
|
|
@ -79,7 +79,7 @@ The following is a list of values that can be used in a `permalink` definition i
|
|||
: the content's section
|
||||
|
||||
`:sections`
|
||||
: the content's sections hierarchy. Uou can use a selection of the sections using _slice syntax_: `:sections[1:]` includes all but the first, `:sections[:last]` includes all but the last, `:sections[last]` includes only the last, `:sections[1:2]` includes section 2 and 3. Note that this slice access will not throw any out-of-bounds errors, so you don't have to be exact.
|
||||
: the content's sections hierarchy. You can use a selection of the sections using _slice syntax_: `:sections[1:]` includes all but the first, `:sections[:last]` includes all but the last, `:sections[last]` includes only the last, `:sections[1:2]` includes section 2 and 3. Note that this slice access will not throw any out-of-bounds errors, so you don't have to be exact.
|
||||
|
||||
`:title`
|
||||
: the content's title
|
||||
|
|
|
@ -55,6 +55,7 @@ With `baseURL = https://example.org/docs/`
|
|||
{{ absLangURL "/" }} → https://example.org/en/
|
||||
{{ absLangURL "/articles" }} → https://example.org/en/articles
|
||||
{{ absLangURL "/style.css" }} → https://example.org/en/style.css
|
||||
```
|
||||
|
||||
{{% note %}}
|
||||
The last three examples are not desirable in most situations. As a best practice, never include a leading slash when using this function.
|
||||
|
|
|
@ -10,7 +10,9 @@ menu:
|
|||
docs:
|
||||
parent: "functions"
|
||||
keywords: [trim]
|
||||
signature: ["chomp INPUT"]
|
||||
signature:
|
||||
- "chomp INPUT"
|
||||
- "strings.Chomp INPUT"
|
||||
workson: []
|
||||
hugoversion:
|
||||
relatedfuncs: [truncate]
|
||||
|
|
|
@ -9,7 +9,9 @@ menu:
|
|||
docs:
|
||||
parent: "functions"
|
||||
keywords: [counting, word count]
|
||||
signature: ["countrunes INPUT"]
|
||||
signature:
|
||||
- "countrunes INPUT"
|
||||
- "strings.CountRunes INPUT"
|
||||
workson: []
|
||||
hugoversion:
|
||||
relatedfuncs: []
|
||||
|
|
15
docs/content/en/functions/crypto.FNV32a.md
Normal file
15
docs/content/en/functions/crypto.FNV32a.md
Normal file
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
title: crypto.FNV32a
|
||||
description: Returns the FNV (Fowler–Noll–Vo) 32 bit hash of a given string.
|
||||
categories: [functions]
|
||||
menu:
|
||||
docs:
|
||||
parent: "functions"
|
||||
keywords: [crypto hash FNV32 Fowler-Noll-Vo]
|
||||
signature: ["crypto.FNV32a STRING"]
|
||||
aliases: []
|
||||
---
|
||||
|
||||
This function calculates the 32 bit [FNV1a hash](https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function#FNV-1a_hash) of a given string according to the [specification](https://datatracker.ietf.org/doc/html/draft-eastlake-fnv-12):
|
||||
|
||||
{{ crypto.FNV32a "Hello world" }} → 1498229191
|
|
@ -9,7 +9,9 @@ menu:
|
|||
docs:
|
||||
parent: "functions"
|
||||
keywords: [dates,time,strings]
|
||||
signature: ["time.Format LAYOUT INPUT"]
|
||||
signature:
|
||||
- "time.Format LAYOUT INPUT"
|
||||
- "dateFormat LAYOUT INPUT"
|
||||
workson: []
|
||||
hugoversion:
|
||||
relatedfuncs: [Format,now,Unix,time]
|
||||
|
|
32
docs/content/en/functions/duration.md
Normal file
32
docs/content/en/functions/duration.md
Normal file
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
title: duration
|
||||
description: Returns a `time.Duration` structure, using the given time unit and duration number.
|
||||
categories: [functions]
|
||||
menu:
|
||||
docs:
|
||||
parent: "functions"
|
||||
keywords: [time duration]
|
||||
signature: ["duration TIME_UNIT DURATION_NUMBER"]
|
||||
aliases: []
|
||||
---
|
||||
|
||||
`time.Duration` converts a given number into a [`time.Duration`](https://pkg.go.dev/time#Duration) structure so you can access its fields. E.g. you can perform [time operations](https://pkg.go.dev/time#Duration) on the returned `time.Duration` value:
|
||||
|
||||
{{ printf "There are %.0f seconds in one day." (duration "hour" 24).Seconds }}
|
||||
<!-- Output: There are 86400 seconds in one day. -->
|
||||
|
||||
Make your code simpler to understand by using a [chained pipeline](https://pkg.go.dev/text/template#hdr-Pipelines):
|
||||
|
||||
{{ mul 7.75 60 | duration "minute" }} → 7h45m0s
|
||||
{{ mul 120 60 | mul 1000 | duration "millisecond" }} → 2h0m0s
|
||||
|
||||
You have to specify a time unit for the number given to the function. Valid time units are:
|
||||
|
||||
Duration|Valid time units
|
||||
:--|:--
|
||||
hours|`hour`, `h`
|
||||
minutes|`minute`, `m`
|
||||
seconds|`second`, `s`
|
||||
milliseconds|`millisecond`, `ms`
|
||||
microseconds|`microsecond`, `us`, `µs`
|
||||
nanoseconds|`nanosecond`, `ns`
|
|
@ -16,7 +16,7 @@ relatedfuncs: []
|
|||
deprecated: false
|
||||
---
|
||||
|
||||
`emoji` runs a passed string through the Emoji emoticons processor.
|
||||
`emojify` runs a passed string through the Emoji emoticons processor.
|
||||
|
||||
See the [Emoji cheat sheet][emojis] for available emoticons.
|
||||
|
||||
|
|
|
@ -12,7 +12,7 @@ signature:
|
|||
relatedfuncs: [replaceRE]
|
||||
aliases: []
|
||||
---
|
||||
By default, the `findRE` function finds all matches. You can limit the number of matches with an optional LIMIT paramater.
|
||||
By default, the `findRE` function finds all matches. You can limit the number of matches with an optional LIMIT parameter.
|
||||
|
||||
When specifying the regular expression, use a raw [string literal] (backticks) instead of an interpreted string literal (double quotes) to simplify the syntax. With an interpreted string literal you must escape backslashes.
|
||||
|
||||
|
|
|
@ -10,7 +10,10 @@ menu:
|
|||
docs:
|
||||
parent: "functions"
|
||||
keywords: [internationalization,i18n,multilingual]
|
||||
signature: ["i18n KEY", "T KEY"]
|
||||
signature:
|
||||
- "i18n KEY"
|
||||
- "T KEY"
|
||||
- "lang.Translate KEY"
|
||||
workson: []
|
||||
hugoversion:
|
||||
relatedfuncs: []
|
||||
|
|
|
@ -10,7 +10,9 @@ menu:
|
|||
docs:
|
||||
parent: "functions"
|
||||
keywords: [strings,casing]
|
||||
signature: ["lower INPUT"]
|
||||
signature:
|
||||
- "lower INPUT"
|
||||
- "strings.ToLower INPUT"
|
||||
workson: []
|
||||
hugoversion:
|
||||
relatedfuncs: []
|
||||
|
@ -18,6 +20,10 @@ deprecated: false
|
|||
aliases: []
|
||||
---
|
||||
|
||||
```
|
||||
{{lower "BatMan"}} → "batman"
|
||||
|
||||
Note that `lower` can be applied in your templates in more than one way:
|
||||
|
||||
```go-html-template
|
||||
{{ lower "BatMan" }} → "batman"
|
||||
{{ "BatMan" | lower }} → "batman"
|
||||
```
|
||||
|
|
|
@ -8,11 +8,13 @@ categories: [functions]
|
|||
menu:
|
||||
docs:
|
||||
parent: "functions"
|
||||
keywords: []
|
||||
signature: ["strings.Replace INPUT OLD NEW [LIMIT]", "replace INPUT OLD NEW [LIMIT]"]
|
||||
keywords: [replace]
|
||||
signature:
|
||||
- "replace INPUT OLD NEW [LIMIT]"
|
||||
- "strings.Replace INPUT OLD NEW [LIMIT]"
|
||||
workson: []
|
||||
hugoversion:
|
||||
relatedfuncs: []
|
||||
relatedfuncs: [replaceRE]
|
||||
deprecated: false
|
||||
aliases: []
|
||||
---
|
||||
|
|
|
@ -5,14 +5,14 @@ categories: [functions]
|
|||
menu:
|
||||
docs:
|
||||
parent: functions
|
||||
keywords: [regex]
|
||||
keywords: [replace regex]
|
||||
signature:
|
||||
- "replaceRE PATTERN REPLACEMENT INPUT [LIMIT]"
|
||||
- "strings.ReplaceRE PATTERN REPLACEMENT INPUT [LIMIT]"
|
||||
relatedfuncs: [findRE]
|
||||
relatedfuncs: [replace,findRE]
|
||||
aliases: []
|
||||
---
|
||||
By default, the `replaceRE` function replaces all matches. You can limit the number of matches with an optional LIMIT paramater.
|
||||
By default, the `replaceRE` function replaces all matches. You can limit the number of matches with an optional LIMIT parameter.
|
||||
|
||||
When specifying the regular expression, use a raw [string literal] (backticks) instead of an interpreted string literal (double quotes) to simplify the syntax. With an interpreted string literal you must escape backslashes.
|
||||
|
||||
|
|
|
@ -10,7 +10,9 @@ menu:
|
|||
docs:
|
||||
parent: "functions"
|
||||
keywords: [strings]
|
||||
signature: ["slicestr STRING START [END]"]
|
||||
signature:
|
||||
- "slicestr STRING START [END]"
|
||||
- "strings.SliceString STRING START [END]"
|
||||
workson: []
|
||||
hugoversion:
|
||||
relatedfuncs: []
|
||||
|
|
18
docs/content/en/functions/strings.Contains.md
Normal file
18
docs/content/en/functions/strings.Contains.md
Normal file
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
title: strings.Contains
|
||||
description: Reports whether a string contains a substring.
|
||||
categories: [functions]
|
||||
menu:
|
||||
docs:
|
||||
parent: "functions"
|
||||
keywords: [string strings substring contains]
|
||||
signature: ["strings.Contains STRING SUBSTRING"]
|
||||
aliases: []
|
||||
relatedfuncs: [strings.ContainsAny]
|
||||
---
|
||||
|
||||
{{ strings.Contains "Hugo" "go" }} → true
|
||||
|
||||
The check is case sensitive:
|
||||
|
||||
{{ strings.Contains "Hugo" "Go" }} → false
|
18
docs/content/en/functions/strings.ContainsAny.md
Normal file
18
docs/content/en/functions/strings.ContainsAny.md
Normal file
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
title: strings.ContainsAny
|
||||
description: Reports whether a string contains any character from a given string.
|
||||
categories: [functions]
|
||||
menu:
|
||||
docs:
|
||||
parent: "functions"
|
||||
keywords: [string strings substring contains any]
|
||||
signature: ["strings.ContainsAny STRING CHARACTERS"]
|
||||
aliases: []
|
||||
relatedfuncs: [strings.Contains]
|
||||
---
|
||||
|
||||
{{ strings.ContainsAny "Hugo" "gm" }} → true
|
||||
|
||||
The check is case sensitive:
|
||||
|
||||
{{ strings.ContainsAny "Hugo" "Gm" }} → false
|
14
docs/content/en/functions/strings.FirstUpper.md
Normal file
14
docs/content/en/functions/strings.FirstUpper.md
Normal file
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
title: strings.FirstUpper
|
||||
description: Capitalizes the first character of a given string.
|
||||
categories: [functions]
|
||||
menu:
|
||||
docs:
|
||||
parent: "functions"
|
||||
keywords: [strings capitalize uppercase first]
|
||||
signature: ["strings.FirstUpper STRING"]
|
||||
hugoversion:
|
||||
aliases: []
|
||||
---
|
||||
|
||||
{{ strings.FirstUpper "foo" }} → "Foo"
|
|
@ -11,7 +11,9 @@ menu:
|
|||
parent: "functions"
|
||||
keywords: [strings]
|
||||
aliases: []
|
||||
signature: ["substr STRING START [LENGTH]"]
|
||||
signature:
|
||||
- "substr STRING START [LENGTH]"
|
||||
- "strings.Substr STRING START [LENGTH]"
|
||||
workson: []
|
||||
hugoversion:
|
||||
relatedfuncs: []
|
||||
|
|
20
docs/content/en/functions/time.ParseDuration.md
Normal file
20
docs/content/en/functions/time.ParseDuration.md
Normal file
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: time.ParseDuration
|
||||
description: Parses a given duration string into a `time.Duration` structure.
|
||||
categories: [functions]
|
||||
menu:
|
||||
docs:
|
||||
parent: "functions"
|
||||
keywords: [time parse duration]
|
||||
signature: ["time.ParseDuration DURATION"]
|
||||
hugoversion:
|
||||
aliases: []
|
||||
---
|
||||
|
||||
`time.ParseDuration` parses a duration string into a [`time.Duration`](https://pkg.go.dev/time#Duration) structure so you can access its fields.
|
||||
A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as `300ms`, `-1.5h` or `2h45m`. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`.
|
||||
|
||||
You can perform [time operations](https://pkg.go.dev/time#Duration) on the returned `time.Duration` value:
|
||||
|
||||
{{ printf "There are %.0f seconds in one day." (time.ParseDuration "24h").Seconds }}
|
||||
<!-- Output: There are 86400 seconds in one day. -->
|
|
@ -10,7 +10,9 @@ menu:
|
|||
docs:
|
||||
parent: "functions"
|
||||
keywords: [strings]
|
||||
signature: ["title INPUT"]
|
||||
signature:
|
||||
- "title INPUT"
|
||||
- "strings.Title INPUT"
|
||||
workson: []
|
||||
hugoversion:
|
||||
relatedfuncs: []
|
||||
|
|
|
@ -10,7 +10,9 @@ menu:
|
|||
docs:
|
||||
parent: "functions"
|
||||
keywords: [strings]
|
||||
signature: ["trim INPUT CUTSET"]
|
||||
signature:
|
||||
- "trim INPUT CUTSET"
|
||||
- "strings.Trim INPUT CUTSET"
|
||||
workson: []
|
||||
hugoversion:
|
||||
relatedfuncs: []
|
||||
|
|
|
@ -10,7 +10,9 @@ menu:
|
|||
docs:
|
||||
parent: "functions"
|
||||
keywords: [strings]
|
||||
signature: ["truncate SIZE INPUT", "truncate SIZE ELLIPSIS INPUT"]
|
||||
signature:
|
||||
- "truncate SIZE [ELLIPSIS] INPUT"
|
||||
- "strings.Truncate SIZE [ELLIPSIS] INPUT"
|
||||
workson: []
|
||||
hugoversion: 19
|
||||
relatedfuncs: []
|
||||
|
|
|
@ -11,7 +11,9 @@ menu:
|
|||
docs:
|
||||
parent: "functions"
|
||||
toc:
|
||||
signature: ["upper INPUT"]
|
||||
signature:
|
||||
- "upper INPUT"
|
||||
- "strings.ToUpper INPUT"
|
||||
workson: []
|
||||
hugoversion:
|
||||
relatedfuncs: []
|
||||
|
|
|
@ -20,18 +20,20 @@ toc: true
|
|||
|
||||
{{< youtube sB0HLHjgQ7E >}}
|
||||
|
||||
Running the `hugo new site` generator from the command-line will create a directory structure with the following elements:
|
||||
Running `hugo new site example` from the command line creates a directory structure with the following elements:
|
||||
|
||||
```txt
|
||||
.
|
||||
├── archetypes
|
||||
├── config.toml
|
||||
├── content
|
||||
├── data
|
||||
├── layouts
|
||||
├── public
|
||||
├── static
|
||||
└── themes
|
||||
example/
|
||||
├── archetypes/
|
||||
│ └── default.md
|
||||
├── assets/
|
||||
├── content/
|
||||
├── data/
|
||||
├── layouts/
|
||||
├── public/
|
||||
├── static/
|
||||
├── themes/
|
||||
└── config.toml
|
||||
```
|
||||
|
||||
## Directory Structure Explained
|
||||
|
@ -43,7 +45,7 @@ The following is a high-level overview of each of the directories with links to
|
|||
By default, Hugo will create new content files with at least `date`, `title` (inferred from the filename), and `draft = true`. This saves time and promotes consistency for sites using multiple content types. You can create your own [archetypes][] with custom preconfigured front matter fields as well.
|
||||
|
||||
[`assets`][]
|
||||
: Stores all the files which need be processed by [Hugo Pipes](/hugo-pipes/). Only the files whose `.Permalink` or `.RelPermalink` are used will be published to the `public` directory. Note: assets directory is not created by default.
|
||||
: Stores all the files which need be processed by [Hugo Pipes](/hugo-pipes/). Only the files whose `.Permalink` or `.RelPermalink` are used will be published to the `public` directory.
|
||||
|
||||
[`config`](/getting-started/configuration/)
|
||||
: Hugo ships with a large number of [configuration directives][].
|
||||
|
|
|
@ -1,176 +1,216 @@
|
|||
---
|
||||
title: Quick Start
|
||||
linktitle: Quick Start
|
||||
description: Create a Hugo site using the beautiful Ananke theme.
|
||||
date: 2013-07-01
|
||||
publishdate: 2013-07-01
|
||||
description: Learn to create a Hugo site in minutes.
|
||||
categories: [getting started]
|
||||
keywords: [quick start,usage]
|
||||
authors: [Shekhar Gulati, Ryan Watters]
|
||||
menu:
|
||||
docs:
|
||||
parent: "getting-started"
|
||||
parent: getting-started
|
||||
weight: 10
|
||||
weight: 10
|
||||
sections_weight: 10
|
||||
draft: false
|
||||
aliases: [/quickstart/,/overview/quickstart/]
|
||||
toc: true
|
||||
aliases: [/quickstart/,/overview/quickstart/]
|
||||
---
|
||||
|
||||
{{% note %}}
|
||||
This quick start uses `macOS` in the examples. For instructions about how to install Hugo on other operating systems, see [install](/installation/).
|
||||
In this tutorial you will:
|
||||
|
||||
It is required to have [Git installed](https://git-scm.com/downloads) to run this tutorial.
|
||||
1. Create a site
|
||||
2. Add content
|
||||
3. Configure the site
|
||||
4. Publish the site
|
||||
|
||||
For other approaches to learning Hugo (like books or video tutorials), refer to the [external learning resources](/getting-started/external-learning-resources/) page.
|
||||
{{% /note %}}
|
||||
## Prerequisites
|
||||
|
||||
## Step 1: Install Hugo
|
||||
Before you begin this tutorial you must:
|
||||
|
||||
Install the **extended version of Hugo** (this is required for the current theme used).
|
||||
1. [Install Hugo] (the extended edition)
|
||||
1. [Install Git]
|
||||
|
||||
{{% note %}}
|
||||
`Homebrew` and `MacPorts`, package managers for `macOS`, can be installed from [brew.sh](https://brew.sh/) or [macports.org](https://www.macports.org/) respectively. See [install](/installation/) if you are running Windows etc.
|
||||
{{% /note %}}
|
||||
You must also be comfortable working from the command line.
|
||||
|
||||
```bash
|
||||
brew install hugo
|
||||
# or
|
||||
port install hugo
|
||||
## Create a site
|
||||
|
||||
### Commands
|
||||
|
||||
Run these commands[^1] to create a Hugo site with the [Ananke] theme. The next section provides an explanation of each command.
|
||||
|
||||
[^1]: If you are a Windows user, you must run these commands with [PowerShell]. You cannot use Windows Powershell, which is a different application, or the Command Prompt.
|
||||
|
||||
```text
|
||||
hugo new site quickstart
|
||||
cd quickstart
|
||||
git init
|
||||
git submodule add https://github.com/theNewDynamic/gohugo-theme-ananke themes/ananke
|
||||
echo "theme = 'ananke'" >> config.toml
|
||||
hugo server
|
||||
```
|
||||
|
||||
To verify your new install:
|
||||
View your site at the URL displayed in your terminal. Press `Ctrl + C` to stop Hugo's development server.
|
||||
|
||||
```bash
|
||||
hugo version
|
||||
# Example output: hugo v0.104.2+extended darwin/amd64 BuildDate=unknown
|
||||
```
|
||||
### Explanation of commands
|
||||
|
||||
It should state that it is `extended`. If it does not, uninstall it and try another installation method.
|
||||
Create the [directory structure] for your project in the `quickstart` directory.
|
||||
|
||||
{{< asciicast ItACREbFgvJ0HjnSNeTknxWy9 >}}
|
||||
|
||||
## Step 2: Create a New Site
|
||||
|
||||
```bash
|
||||
```text
|
||||
hugo new site quickstart
|
||||
```
|
||||
|
||||
The above will create a new Hugo site in a folder named `quickstart`.
|
||||
Change the current directory to the root of your project.
|
||||
|
||||
{{< asciicast 3mf1JGaN0AX0Z7j5kLGl3hSh8 >}}
|
||||
|
||||
## Step 3: Add a Theme
|
||||
|
||||
See [themes.gohugo.io](https://themes.gohugo.io/) for a list of themes to consider. This quickstart uses the beautiful [Ananke theme](https://themes.gohugo.io/gohugo-theme-ananke/).
|
||||
|
||||
First, download the theme from GitHub and add it to your site's `themes` directory:
|
||||
|
||||
```bash
|
||||
```text
|
||||
cd quickstart
|
||||
```
|
||||
|
||||
Initialize an empty Git repository in the current directory.
|
||||
|
||||
```text
|
||||
git init
|
||||
git submodule add https://github.com/theNewDynamic/gohugo-theme-ananke.git themes/ananke
|
||||
```
|
||||
|
||||
Then, add the theme to the site configuration:
|
||||
Clone the [Ananke] theme into the `themes` directory, adding it to your project as a [Git submodule].
|
||||
|
||||
```bash
|
||||
echo theme = \"ananke\" >> config.toml
|
||||
```text
|
||||
git submodule add https://github.com/theNewDynamic/gohugo-theme-ananke themes/ananke
|
||||
```
|
||||
|
||||
{{< asciicast 7naKerRYUGVPj8kiDmdh5k5h9 >}}
|
||||
Append a line to the site configuration file, indicating the current theme.
|
||||
|
||||
## Step 4: Add Some Content
|
||||
```text
|
||||
echo "theme = 'ananke'" >> config.toml
|
||||
```
|
||||
|
||||
You can manually create content files (for example as `content/<CATEGORY>/<FILE>.<FORMAT>`) and provide metadata in them, however you can use the `new` command to do a few things for you (like add title and date):
|
||||
Start Hugo's development server to view the site.
|
||||
|
||||
```txt
|
||||
```text
|
||||
hugo server
|
||||
```
|
||||
|
||||
Press `Ctrl + C` to stop Hugo's development server.
|
||||
|
||||
## Add content
|
||||
|
||||
Add a new page to your site.
|
||||
|
||||
```text
|
||||
hugo new posts/my-first-post.md
|
||||
```
|
||||
|
||||
{{< asciicast eUojYCfRTZvkEiqc52fUsJRBR >}}
|
||||
Hugo created the file in the `content/posts` directory. Open the file with your editor.
|
||||
|
||||
Edit the newly created content file if you want, it will start with something like this:
|
||||
|
||||
```md
|
||||
```text
|
||||
---
|
||||
title: "My First Post"
|
||||
date: 2019-03-26T08:47:11+01:00
|
||||
date: 2022-11-20T09:03:20-08:00
|
||||
draft: true
|
||||
---
|
||||
```
|
||||
|
||||
Notice the `draft` value in the [front matter] is `true`. By default, Hugo does not publish draft content when you build the site. Learn more about [draft, future, and expired content].
|
||||
|
||||
Add some [markdown] to the body of the post, but do not change the `draft` value.
|
||||
|
||||
[markdown]: https://commonmark.org/help/
|
||||
|
||||
```text
|
||||
---
|
||||
title: "My First Post"
|
||||
date: 2022-11-20T09:03:20-08:00
|
||||
draft: true
|
||||
---
|
||||
## Introduction
|
||||
|
||||
This is **bold** text, and this is *emphasized* text.
|
||||
|
||||
Visit the [Hugo](https://gohugo.io) website!
|
||||
```
|
||||
|
||||
Save the file, then start Hugo’s development server to view the site. You can run either of the following commands to include draft content.
|
||||
|
||||
```text
|
||||
hugo server --buildDrafts
|
||||
hugo server -D
|
||||
```
|
||||
|
||||
View your site at the URL displayed in your terminal. Keep the development server running as you continue to add and change content.
|
||||
|
||||
{{% note %}}
|
||||
Hugo's rendering engine conforms to the CommonMark [specification] for markdown. The CommonMark organization provides a useful [live testing tool] powered by the reference implementation.
|
||||
|
||||
[live testing tool]: https://spec.commonmark.org/dingus/
|
||||
[specification]: https://spec.commonmark.org/
|
||||
{{% /note %}}
|
||||
|
||||
## Configure the site
|
||||
|
||||
With your editor, open the [site configuration] file (`config.toml`) in the root of your project.
|
||||
|
||||
```text
|
||||
baseURL = 'http://example.org/'
|
||||
languageCode = 'en-us'
|
||||
title = 'My New Hugo Site'
|
||||
theme = 'ananke'
|
||||
```
|
||||
|
||||
Make the following changes:
|
||||
|
||||
1. Set the `baseURL` for your production site. This value must begin with the protocol and end with a slash, as shown above.
|
||||
|
||||
2. Set the `languageCode` to your language and region.
|
||||
|
||||
3. Set the `title` for your production site.
|
||||
|
||||
Start Hugo's development server to see your changes, remembering to include draft content.
|
||||
|
||||
```text
|
||||
hugo server -D
|
||||
```
|
||||
|
||||
{{% note %}}
|
||||
Drafts do not get deployed; once you finish a post, update the header of the post to say `draft: false`. More info [here](/getting-started/usage/#draft-future-and-expired-content).
|
||||
Most theme authors provide configuration guidelines and options. Make sure to visit your theme's repository or documentation site for details.
|
||||
|
||||
[The New Dynamic], authors of the Ananke theme, provide [documentation] for configuration and usage. They also provide a [demonstration site].
|
||||
|
||||
[demonstration site]: https://gohugo-ananke-theme-demo.netlify.app/
|
||||
[documentation]: https://github.com/theNewDynamic/gohugo-theme-ananke#readme
|
||||
[The New Dynamic]: https://www.thenewdynamic.com/
|
||||
{{% /note %}}
|
||||
|
||||
## Step 5: Start the Hugo server
|
||||
## Publish the site
|
||||
|
||||
Now, start the Hugo server with [drafts](/getting-started/usage/#draft-future-and-expired-content) enabled:
|
||||
In this step you will _publish_ your site, but you will not _deploy_ it.
|
||||
|
||||
{{< asciicast BvJBsF6egk9c163bMsObhuNXj >}}
|
||||
When you _publish_ your site, Hugo creates the entire static site in the `public` directory in the root of your project. This includes the HTML files, and assets such as images, CSS files, and JavaScript files.
|
||||
|
||||
```txt
|
||||
▶ hugo server -D
|
||||
When you publish your site, you typically do _not_ want to include [draft, future, or expired content]. The command is simple.
|
||||
|
||||
| EN
|
||||
+------------------+----+
|
||||
Pages | 10
|
||||
Paginator pages | 0
|
||||
Non-page files | 0
|
||||
Static files | 3
|
||||
Processed images | 0
|
||||
Aliases | 1
|
||||
Sitemaps | 1
|
||||
Cleaned | 0
|
||||
|
||||
Total in 11 ms
|
||||
Watching for changes in /Users/bep/quickstart/{content,data,layouts,static,themes}
|
||||
Watching for config changes in /Users/bep/quickstart/config.toml
|
||||
Environment: "development"
|
||||
Serving pages from memory
|
||||
Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender
|
||||
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
|
||||
Press Ctrl+C to stop
|
||||
```text
|
||||
hugo
|
||||
```
|
||||
|
||||
**Navigate to your new site at [http://localhost:1313/](http://localhost:1313/).**
|
||||
To learn how to _deploy_ your site, see the [hosting and deployment] section.
|
||||
|
||||
Feel free to edit or add new content and you will see the changes in the browser right away while the Hugo server is running. (You might need to force refresh your web browser, something like Ctrl-R usually works.)
|
||||
## Ask for help
|
||||
|
||||
## Step 6: Customize the Theme
|
||||
Hugo's [forum] is an active community of users and developers who answer questions, share knowledge, and provide examples. A quick search of over 20,000 topics will often answer your question. Please be sure to read about [requesting help] before asking your first question.
|
||||
|
||||
Your new site already looks great, but you will want to tweak it a little before you release it to the public.
|
||||
## Other resources
|
||||
|
||||
### Site Configuration
|
||||
For other resources to help you learn Hugo, including books and video tutorials, see the [external learning resources](/getting-started/external-learning-resources/) page.
|
||||
|
||||
Open up `config.toml` in a text editor:
|
||||
|
||||
```toml
|
||||
baseURL = "https://example.org/"
|
||||
languageCode = "en-us"
|
||||
title = "My New Hugo Site"
|
||||
theme = "ananke"
|
||||
```
|
||||
|
||||
Replace the `title` above with something more personal. Also, if you already have a domain ready, set the `baseURL`. Note that this value is not needed when running the local development server.
|
||||
|
||||
{{% note %}}
|
||||
**Tip:** Make the changes to the site configuration or any other file in your site while the Hugo server is running, and you will see the changes in the browser right away, though you may need to [clear your cache](https://kb.iu.edu/d/ahic).
|
||||
{{% /note %}}
|
||||
|
||||
For theme specific configuration options, see the [theme site](https://github.com/theNewDynamic/gohugo-theme-ananke).
|
||||
|
||||
**For further theme customization, see [Customize a Theme](/themes/customizing/).**
|
||||
|
||||
### Step 7: Build static pages
|
||||
|
||||
It is simple. Just call:
|
||||
|
||||
```txt
|
||||
hugo -D
|
||||
```
|
||||
|
||||
Output will be in `./public/` directory by default (`-d`/`--destination` flag to change it, or set `publishdir` in the config file).
|
||||
[Ananke]: https://github.com/theNewDynamic/gohugo-theme-ananke
|
||||
[directory structure]: /getting-started/directory-structure
|
||||
[draft, future, and expired content]: /getting-started/usage/#draft-future-and-expired-content
|
||||
[draft, future, or expired content]: /getting-started/usage/#draft-future-and-expired-content
|
||||
[external learning resources]:/getting-started/external-learning-resources/
|
||||
[forum]: https://discourse.gohugo.io/
|
||||
[forum]: https://discourse.gohugo.io/
|
||||
[front matter]: /content-management/front-matter
|
||||
[Git submodule]: https://git-scm.com/book/en/v2/Git-Tools-Submodules
|
||||
[hosting and deployment]: /hosting-and-deployment/
|
||||
[Install Git]: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
|
||||
[Install Hugo]: /installation/
|
||||
[PowerShell]: https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows
|
||||
[Requesting Help]: https://discourse.gohugo.io/t/requesting-help/9132
|
||||
[Requesting Help]: https://discourse.gohugo.io/t/requesting-help/9132
|
||||
[site configuration]: /getting-started/configuration/
|
||||
|
|
|
@ -14,6 +14,6 @@ sections_weight: 50
|
|||
toc: true
|
||||
---
|
||||
|
||||
You can host your Hugo site using [Cloudflare Pages](https://developers.cloudflare.com/pages/). Pages are super fast, always up-to-date, and deployed directly from your Git provider (currently supports only GitHub and GitLab).
|
||||
[Cloudflare Pages](https://developers.cloudflare.com/pages/) are super fast, always up-to-date, and deployed directly from your Git provider (currently supports only GitHub and GitLab).
|
||||
|
||||
Cloudflare Pages has a handy tutorial on [how to deploy a Hugo site](https://developers.cloudflare.com/pages/framework-guides/deploy-a-hugo-site/).
|
||||
Cloudflare Pages docs have a detailed tutorial on [how to deploy a Hugo site](https://developers.cloudflare.com/pages/framework-guides/deploy-a-hugo-site/).
|
||||
|
|
|
@ -12,8 +12,6 @@ images:
|
|||
|
||||
Hugo has been caching the highlighter output to disk, so for repeated builds it has been fine, but this little snippet, showing a build of the [gohugo.io](https://gohugo.io/) site without cache and with both Pygments and Chroma, should illustrate the improvement:
|
||||
|
||||
{{< asciicast Lc5iwTVny2kuUC8lqvNnL6oDU >}}
|
||||
|
||||
See the [Updated Documentation](https://gohugo.io/content-management/syntax-highlighting/) for more information about how this works.
|
||||
|
||||
Worth mentioning is also the `liveReloadPort` flag on `hugo server`, which makes it possible to do "live reloads" behind a HTTPS proxy, which makes for very cool remote customer demos.
|
||||
|
@ -61,4 +59,3 @@ Hugo now has:
|
|||
* Add `liveReloadPort` flag to server [b1804776](https://github.com/gohugoio/hugo/commit/b180477631555824a06293053e2b6e63c5f07361) [@bep](https://github.com/bep) [#3882](https://github.com/gohugoio/hugo/issues/3882)
|
||||
* Add `noHTTPCache` flag to hugo server (default on) [0b34af21](https://github.com/gohugoio/hugo/commit/0b34af216154367af7f53ce93d44e6b3d58c3f34) [@bep](https://github.com/bep) [#3897](https://github.com/gohugoio/hugo/issues/3897)
|
||||
* Make `noHTTPCache` default on [80c7ea60](https://github.com/gohugoio/hugo/commit/80c7ea60a0e0f488563a6b7311f3d4c23457aac7) [@bep](https://github.com/bep) [#3897](https://github.com/gohugoio/hugo/issues/3897)
|
||||
|
||||
|
|
|
@ -2,4 +2,4 @@ module github.com/gohugoio/hugoDocs
|
|||
|
||||
go 1.16
|
||||
|
||||
require github.com/gohugoio/gohugoioTheme v0.0.0-20221116211530-5ae8dcdd68d6 // indirect
|
||||
require github.com/gohugoio/gohugoioTheme v0.0.0-20221124154621-1451a01f406b // indirect
|
||||
|
|
|
@ -41,3 +41,7 @@ github.com/gohugoio/gohugoioTheme v0.0.0-20220914071648-0ef1c51685bf h1:A8Ksnvp8
|
|||
github.com/gohugoio/gohugoioTheme v0.0.0-20220914071648-0ef1c51685bf/go.mod h1:kpw3SS48xZvLQGEXKu8u5XHgXkPvL8DX3oGa07+z8Bs=
|
||||
github.com/gohugoio/gohugoioTheme v0.0.0-20221116211530-5ae8dcdd68d6 h1:eG53kL1LkQuKmrDdzbvvx6d60qM07zp2Wjo/tYxkDOY=
|
||||
github.com/gohugoio/gohugoioTheme v0.0.0-20221116211530-5ae8dcdd68d6/go.mod h1:kpw3SS48xZvLQGEXKu8u5XHgXkPvL8DX3oGa07+z8Bs=
|
||||
github.com/gohugoio/gohugoioTheme v0.0.0-20221118083537-967e29e21382 h1:e30rl1dxWkYOcgdl0omeOK0HBzgDLI/b9MfYHrINjzU=
|
||||
github.com/gohugoio/gohugoioTheme v0.0.0-20221118083537-967e29e21382/go.mod h1:kpw3SS48xZvLQGEXKu8u5XHgXkPvL8DX3oGa07+z8Bs=
|
||||
github.com/gohugoio/gohugoioTheme v0.0.0-20221124154621-1451a01f406b h1:TRrIisSY7ckt9FVHOOQtmKG4jsnORCYn72UMvMu+IQ0=
|
||||
github.com/gohugoio/gohugoioTheme v0.0.0-20221124154621-1451a01f406b/go.mod h1:kpw3SS48xZvLQGEXKu8u5XHgXkPvL8DX3oGa07+z8Bs=
|
||||
|
|
1
docs/layouts/partials/boxes-small-news.html
Normal file
1
docs/layouts/partials/boxes-small-news.html
Normal file
|
@ -0,0 +1 @@
|
|||
{{/* Empty for now. */}}
|
|
@ -1,2 +0,0 @@
|
|||
{{ $id := .Get 0 }}
|
||||
<script type="text/javascript" src="https://asciinema.org/a/{{ $id }}.js" id="asciicast-{{ $id }}" data-rows="10" async></script>
|
|
@ -3,7 +3,7 @@ publish = "public"
|
|||
command = "hugo --gc --minify"
|
||||
|
||||
[context.production.environment]
|
||||
HUGO_VERSION = "0.105.0"
|
||||
HUGO_VERSION = "0.107.0"
|
||||
HUGO_ENV = "production"
|
||||
HUGO_ENABLEGITINFO = "true"
|
||||
|
||||
|
@ -11,20 +11,20 @@ HUGO_ENABLEGITINFO = "true"
|
|||
command = "hugo --gc --minify --enableGitInfo"
|
||||
|
||||
[context.split1.environment]
|
||||
HUGO_VERSION = "0.105.0"
|
||||
HUGO_VERSION = "0.107.0"
|
||||
HUGO_ENV = "production"
|
||||
|
||||
[context.deploy-preview]
|
||||
command = "hugo --gc --minify --buildFuture -b $DEPLOY_PRIME_URL"
|
||||
|
||||
[context.deploy-preview.environment]
|
||||
HUGO_VERSION = "0.105.0"
|
||||
HUGO_VERSION = "0.107.0"
|
||||
|
||||
[context.branch-deploy]
|
||||
command = "hugo --gc --minify -b $DEPLOY_PRIME_URL"
|
||||
|
||||
[context.branch-deploy.environment]
|
||||
HUGO_VERSION = "0.105.0"
|
||||
HUGO_VERSION = "0.107.0"
|
||||
|
||||
[context.next.environment]
|
||||
HUGO_ENABLEGITINFO = "true"
|
||||
|
|
Loading…
Reference in a new issue