mirror of
https://github.com/gohugoio/hugo.git
synced 2025-08-15 20:44:01 +02:00
docs: Replace /docs
This commit is contained in:
Bjørn Erik Pedersen
@@ -1,26 +0,0 @@
|
||||
---
|
||||
title: Troubleshoot
|
||||
linktitle: Troubleshoot
|
||||
description: Frequently asked questions and known issues pulled from the Hugo Discuss forum.
|
||||
date: 2017-02-01
|
||||
publishdate: 2017-02-01
|
||||
lastmod: 2017-02-01
|
||||
menu:
|
||||
docs:
|
||||
parent: "troubleshooting"
|
||||
weight: 1
|
||||
weight: 1
|
||||
draft: false
|
||||
hidesectioncontents: false
|
||||
slug:
|
||||
aliases: [/troubleshooting/faqs/,/faqs/]
|
||||
toc: false
|
||||
notesforauthors:
|
||||
---
|
||||
|
||||
The Troubleshooting section includes known issues, recent workarounds, and FAQs pulled from the [Hugo Discussion Forum][forum].
|
||||
|
||||
|
||||
|
||||
|
||||
[forum]: https://discourse.gohugo.io
|
||||
@@ -1,101 +0,0 @@
|
||||
---
|
||||
title: Build Performance
|
||||
linktitle: Build Performance
|
||||
description: An overview of features used for diagnosing and improving performance issues in site builds.
|
||||
date: 2017-03-12
|
||||
publishdate: 2017-03-12
|
||||
lastmod: 2017-03-12
|
||||
keywords: [performance, build]
|
||||
categories: [troubleshooting]
|
||||
menu:
|
||||
docs:
|
||||
parent: "troubleshooting"
|
||||
weight: 3
|
||||
slug:
|
||||
aliases: []
|
||||
toc: true
|
||||
---
|
||||
|
||||
{{% note %}}
|
||||
The example site used below is from https://github.com/gohugoio/hugo/tree/master/examples/blog
|
||||
{{% /note %}}
|
||||
|
||||
## Template Metrics
|
||||
|
||||
Hugo is a very fast static site generator, but it is possible to write
|
||||
inefficient templates. Hugo's *template metrics* feature is extremely helpful
|
||||
in pinpointing which templates are executed most often and how long those
|
||||
executions take **in terms of CPU time**.
|
||||
|
||||
| Metric Name | Description |
|
||||
|---------------------|-------------|
|
||||
| cumulative duration | The cumulative time spent executing a given template. |
|
||||
| average duration | The average time spent executing a given template. |
|
||||
| maximum duration | The maximum time a single execution took for a given template. |
|
||||
| count | The number of times a template was executed. |
|
||||
| template | The template name. |
|
||||
|
||||
```
|
||||
▶ hugo --templateMetrics
|
||||
Started building sites ...
|
||||
|
||||
Built site for language en:
|
||||
0 draft content
|
||||
0 future content
|
||||
0 expired content
|
||||
2 regular pages created
|
||||
22 other pages created
|
||||
0 non-page files copied
|
||||
0 paginator pages created
|
||||
4 tags created
|
||||
3 categories created
|
||||
total in 18 ms
|
||||
|
||||
Template Metrics:
|
||||
|
||||
cumulative average maximum
|
||||
duration duration duration count template
|
||||
---------- -------- -------- ----- --------
|
||||
6.419663ms 583.605µs 994.374µs 11 _internal/_default/rss.xml
|
||||
4.718511ms 1.572837ms 3.880742ms 3 indexes/category.html
|
||||
4.642666ms 2.321333ms 3.282842ms 2 posts/single.html
|
||||
4.364445ms 396.767µs 2.451372ms 11 partials/header.html
|
||||
2.346069ms 586.517µs 903.343µs 4 indexes/tag.html
|
||||
2.330919ms 211.901µs 2.281342ms 11 partials/header.includes.html
|
||||
1.238976ms 103.248µs 446.084µs 12 posts/li.html
|
||||
972.16µs 972.16µs 972.16µs 1 _internal/_default/sitemap.xml
|
||||
953.597µs 953.597µs 953.597µs 1 index.html
|
||||
822.263µs 822.263µs 822.263µs 1 indexes/post.html
|
||||
567.498µs 51.59µs 112.205µs 11 partials/navbar.html
|
||||
348.22µs 31.656µs 88.249µs 11 partials/meta.html
|
||||
346.782µs 173.391µs 276.176µs 2 posts/summary.html
|
||||
235.184µs 21.38µs 124.383µs 11 partials/footer.copyright.html
|
||||
132.003µs 12µs 117.999µs 11 partials/menu.html
|
||||
72.547µs 6.595µs 63.764µs 11 partials/footer.html
|
||||
```
|
||||
|
||||
{{% note %}}
|
||||
**A Note About Parallelism**
|
||||
|
||||
Hugo builds pages in parallel where multiple pages are generated
|
||||
simultaneously. Because of this parallelism, the sum of "cumulative duration"
|
||||
values is usually greater than the actual time it takes to build a site.
|
||||
{{% /note %}}
|
||||
|
||||
|
||||
## Cached Partials
|
||||
|
||||
Some `partial` templates such as sidebars or menus are executed many times
|
||||
during a site build. Depending on the content within the `partial` template and
|
||||
the desired output, the template may benefit from caching to reduce the number
|
||||
of executions. The [`partialCached`][partialCached] template function provides
|
||||
caching capabilities for `partial` templates.
|
||||
|
||||
{{% tip %}}
|
||||
Note that you can create cached variants of each `partial` by passing additional
|
||||
parameters to `partialCached` beyond the initial context. See the
|
||||
`partialCached` documentation for more details.
|
||||
{{% /tip %}}
|
||||
|
||||
|
||||
[partialCached]:{{< ref "/functions/partialCached.md" >}}
|
||||
@@ -1,56 +0,0 @@
|
||||
---
|
||||
title: Frequently Asked Questions
|
||||
linktitle: FAQ
|
||||
description: Solutions to some common Hugo problems.
|
||||
date: 2018-02-10
|
||||
categories: [troubleshooting]
|
||||
menu:
|
||||
docs:
|
||||
parent: "troubleshooting"
|
||||
keywords: [faqs]
|
||||
weight: 2
|
||||
toc: true
|
||||
aliases: [/faq/]
|
||||
---
|
||||
|
||||
{{% note %}}
|
||||
**Note:** The answers/solutions presented below are short, and may not be note be enough to solve your problem. Visit [Hugo Discourse](https://discourse.gohugo.io/) and use the search. It that does not help, start a new topic and ask your questions.
|
||||
{{% /note %}}
|
||||
|
||||
## I can't see my content!
|
||||
|
||||
Is your markdown file [in draft mode](https://gohugo.io/content-management/front-matter/#front-matter-variables)? When testing, run `hugo server` with the `-D` or `--buildDrafts` [switch](https://gohugo.io/getting-started/usage/#draft-future-and-expired-content).
|
||||
|
||||
## Can I set configuration variables via OS environment?
|
||||
|
||||
Yes you can! See [Configure with Environment Variables](/getting-started/configuration/#configure-with-environment-variables).
|
||||
|
||||
## How do I schedule posts?
|
||||
|
||||
1. Set `publishDate` in the page [Front Matter](/content-management/front-matter/) to a date in the future.
|
||||
2. Build and publish at intervals.
|
||||
|
||||
How to automate the "publish at intervals" part depends on your situation:
|
||||
|
||||
* If you deploy from your own PC/server, you can automate with [Cron](https://en.wikipedia.org/wiki/Cron) or similar.
|
||||
* If your site is hosted on a service similar to [Netlify](https://www.netlify.com/) you can use a service such as [ifttt](https://ifttt.com/date_and_time) to schedule the updates.
|
||||
|
||||
Also see this Twitter thread:
|
||||
|
||||
{{< tweet 962380712027590657 >}}
|
||||
|
||||
## Can I use the latest Hugo version on Netlify?
|
||||
|
||||
Yes you can! Read [this](/hosting-and-deployment/hosting-on-netlify/#configure-hugo-version-in-netlify).
|
||||
|
||||
## I get "TOCSS ... this feature is not available in your current Hugo version"
|
||||
|
||||
If you process `SCSS` or `SASS` to `CSS` in your Hugo project, you need the Hugo `extended` version, or else you may see this error message:
|
||||
|
||||
```bash
|
||||
error: failed to transform resource: TOCSS: failed to transform "scss/main.scss" (text/x-scss): this feature is not available in your current Hugo version
|
||||
```
|
||||
|
||||
We release two set of binaries for technical reasons. The extended is not what you get by default, as an example, when you run `brew install hugo` on `macOS`. On the [release page](https://github.com/gohugoio/hugo/releases), look for archives with `extended` in the name. To build `hugo-extended`, use `go install --tags extended`
|
||||
|
||||
To confirm, run `hugo version` and look for the word `extended`.
|
||||
Reference in New Issue
Block a user