summaryrefslogtreecommitdiffstats
path: root/docs/content/en/getting-started
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2022-03-26 11:04:57 +0200
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2022-03-26 11:04:57 +0200
commitd7497b28c17fe2f402accde45c75642ed7f09d08 (patch)
treeec560802471331c111fb1fec0fd639509c50560d /docs/content/en/getting-started
parent94459680ba391275ac667407627cafdab5a50d79 (diff)
parentd276e901b36d2576ef8350ed96b17f66254eac1b (diff)
Diffstat (limited to 'docs/content/en/getting-started')
-rw-r--r--docs/content/en/getting-started/configuration-markup.md116
-rw-r--r--docs/content/en/getting-started/configuration.md16
-rw-r--r--docs/content/en/getting-started/installing.md2
3 files changed, 18 insertions, 116 deletions
diff --git a/docs/content/en/getting-started/configuration-markup.md b/docs/content/en/getting-started/configuration-markup.md
index e19bbe47f..b323ba464 100644
--- a/docs/content/en/getting-started/configuration-markup.md
+++ b/docs/content/en/getting-started/configuration-markup.md
@@ -119,119 +119,5 @@ ordered
## Markdown Render Hooks
-{{< new-in "0.62.0" >}}
+See [Markdown Render Hooks](/templates/render-hooks/).
-Note that this is only supported with the [Goldmark](#goldmark) renderer.
-
-Render Hooks allow custom templates to override markdown rendering functionality. You can do this by creating templates with base names `render-{feature}` in `layouts/_default/_markup`.
-
-You can also create type/section specific hooks in `layouts/[type/section]/_markup`, e.g.: `layouts/blog/_markup`.{{< new-in "0.71.0" >}}
-
-The features currently supported are:
-
-* `image`
-* `link`
-* `heading` {{< new-in "0.71.0" >}}
-
-You can define [Output-Format-](/templates/output-formats) and [language-](/content-management/multilingual/)specific templates if needed. Your `layouts` folder may look like this:
-
-```bash
-layouts
-└── _default
- └── _markup
- ├── render-image.html
- ├── render-image.rss.xml
- └── render-link.html
-```
-
-Some use cases for the above:
-
-* Resolve link references using `.GetPage`. This would make links portable as you could translate `./my-post.md` (and similar constructs that would work on GitHub) into `/blog/2019/01/01/my-post/` etc.
-* Add `target=_blank` to external links.
-* Resolve and [process](/content-management/image-processing/) images.
-* Add [header links](https://remysharp.com/2014/08/08/automatic-permalinks-for-blog-posts).
-
-### Render Hook Templates
-
-The `render-link` and `render-image` templates will receive this context:
-
-Page
-: The [Page](/variables/page/) being rendered.
-
-Destination
-: The URL.
-
-Title
-: The title attribute.
-
-Text
-: The rendered (HTML) link text.
-
-PlainText
-: The plain variant of the above.
-
-The `render-heading` template will receive this context:
-
-Page
-: The [Page](/variables/page/) being rendered.
-
-Level
-: The header level (1--6)
-
-Anchor
-: An auto-generated html id unique to the header within the page
-
-Text
-: The rendered (HTML) text.
-
-PlainText
-: The plain variant of the above.
-
-Attributes (map) {{< new-in "0.82.0" >}}
-: A map of attributes (e.g. `id`, `class`)
-
-#### Link with title Markdown example:
-
-```md
-[Text](https://www.gohugo.io "Title")
-```
-
-Here is a code example for how the render-link.html template could look:
-
-{{< code file="layouts/_default/_markup/render-link.html" >}}
-<a href="{{ .Destination | safeURL }}"{{ with .Title}} title="{{ . }}"{{ end }}{{ if strings.HasPrefix .Destination "http" }} target="_blank" rel="noopener"{{ end }}>{{ .Text | safeHTML }}</a>
-{{< /code >}}
-
-#### Image Markdown example:
-
-```md
-![Text](https://d33wubrfki0l68.cloudfront.net/c38c7334cc3f23585738e40334284fddcaf03d5e/2e17c/images/hugo-logo-wide.svg "Title")
-```
-
-Here is a code example for how the render-image.html template could look:
-
-{{< code file="layouts/_default/_markup/render-image.html" >}}
-<p class="md__image">
- <img src="{{ .Destination | safeURL }}" alt="{{ .Text }}" {{ with .Title}} title="{{ . }}"{{ end }} />
-</p>
-{{< /code >}}
-
-#### Heading link example
-
-Given this template file
-
-{{< code file="layouts/_default/_markup/render-heading.html" >}}
-<h{{ .Level }} id="{{ .Anchor | safeURL }}">{{ .Text | safeHTML }} <a href="#{{ .Anchor | safeURL }}">¶</a></h{{ .Level }}>
-{{< /code >}}
-
-And this markdown
-
-```md
-### Section A
-```
-
-The rendered html will be
-
-```html
-<h3 id="section-a">Section A <a href="#section-a">¶</a></h3>
-```
diff --git a/docs/content/en/getting-started/configuration.md b/docs/content/en/getting-started/configuration.md
index 2123558d9..aed0ea100 100644
--- a/docs/content/en/getting-started/configuration.md
+++ b/docs/content/en/getting-started/configuration.md
@@ -310,12 +310,21 @@ See [Configure Minify](#configure-minify)
Module config see [Module Config](/hugo-modules/configuration/).{{< new-in "0.56.0" >}}
### newContentEditor
+
+**Default value:** ""
+
The editor to use when creating new content.
### noChmod
+
+**Default value:** false
+
Don't sync permission mode of files.
### noTimes
+
+**Default value:** false
+
Don't sync modification time of files.
### outputFormats
@@ -352,6 +361,9 @@ The directory to where Hugo will write the final static site (the HTML files etc
: See [Related Content](/content-management/related/#configure-related-content).{{< new-in "0.27" >}}
### relativeURLs
+
+**Default value:** false
+
Enable this to make all relative URLs relative to content root. Note that this does not affect absolute URLs.
### refLinksErrorLevel
@@ -376,6 +388,8 @@ content/post/hügó.md --> https://example.org/post/hugo/
### rssLimit
+**Default value:** -1 (unlimited)
+
Maximum number of items in the RSS feed.
### sectionPagesMenu
@@ -432,6 +446,8 @@ When enabled, creates URL of the form `/filename.html` instead of `/filename/`.
### watch
+**Default value:** false
+
Watch filesystem for changes and recreate as needed.
{{% note %}}
diff --git a/docs/content/en/getting-started/installing.md b/docs/content/en/getting-started/installing.md
index 2a9b8fa4b..0fb20c434 100644
--- a/docs/content/en/getting-started/installing.md
+++ b/docs/content/en/getting-started/installing.md
@@ -560,4 +560,4 @@ Now that you've installed Hugo, read the [Quick Start guide][quickstart] and exp
[Scoop]: https://scoop.sh/
[snaps]: https://snapcraft.io/docs/installing-snapd
[windowsarch]: https://esupport.trendmicro.com/en-us/home/pages/technical-support/1038680.aspx
-[Windows Environment Variables Editor]: http://eveditor.com/
+[Windows Environment Variables Editor]: https://eveditor.com/