{{ .ShortBio }}
-{{.Title}}
{{end}} ``` @@ -95,7 +95,7 @@ When using booleans you should not put quotation marks. ## Use `where` with `intersect` ```go-html-template -{{ range where .Site.Pages ".Params.tags" "intersect" .Params.tags }} +{{ range where .Site.Pages "Params.tags" "intersect" .Params.tags }} {{ if ne .Permalink $.Permalink }} {{ .Render "summary" }} {{ end }} @@ -131,7 +131,7 @@ then ranges through only the first 5 posts in that list: You can also nest `where` clauses to drill down on lists of content by more than one parameter. The following first grabs all pages in the "blog" section and then ranges through the result of the first `where` clause and finds all pages that are *not* featured: ```go-html-template -{{ range where (where .Pages "Section" "blog" ) ".Params.featured" "!=" true }} +{{ range where (where .Pages "Section" "blog" ) "Params.featured" "!=" true }} ``` ## Unset Fields @@ -146,7 +146,7 @@ Only the following operators are available for `nil` * `!=`, `<>`, `ne`: True if the given field is set. ```go-html-template -{{ range where .Pages ".Params.specialpost" "!=" nil }} +{{ range where .Pages "Params.specialpost" "!=" nil }} {{ .Content }} {{ end }} ``` @@ -166,12 +166,12 @@ section names to hard-coded values like `"posts"` or `"post"`. If the user has not set this config parameter in their site config, it will default to the _section with the most pages_. -The user can override the default in `config.toml`: +The user can override the default: -```toml +{{< code-toggle file="config" >}} [params] mainSections = ["blog", "docs"] -``` +{{< /code-toggle >}} [intersect]: /functions/intersect/ [wherekeyword]: https://www.techonthenet.com/sql/where.php diff --git a/content/en/getting-started/configuration-markup.md b/content/en/getting-started/configuration-markup.md index 4c4d270a6..14a23b734 100644 --- a/content/en/getting-started/configuration-markup.md +++ b/content/en/getting-started/configuration-markup.md @@ -68,6 +68,14 @@ There are some current limitations: For tables you can currently only apply it t {.list} ``` +Note that attributes in [code fences](/content-management/syntax-highlighting/#highlighting-in-code-fences) must come after the opening tag, with any other highlighting processing instruction, e.g.: + +```` +```go {.myclass linenos=table,hl_lines=[8,"15-17"],linenostart=199} +// ... code +``` +```` + autoHeadingIDType ("github") {{< new-in "0.62.2" >}} : The strategy used for creating auto IDs (anchor names). Available types are `github`, `github-ascii` and `blackfriday`. `github` produces GitHub-compatible IDs, `github-ascii` will drop any non-Ascii characters after accent normalization, and `blackfriday` will make the IDs work as with [Blackfriday](#blackfriday), the default Markdown engine before Hugo 0.60. Note that if Goldmark is your default Markdown engine, this is also the strategy used in the [anchorize](/functions/anchorize/) template func. @@ -179,6 +187,9 @@ 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 diff --git a/content/en/getting-started/configuration.md b/content/en/getting-started/configuration.md index 1f8ad40c5..48a4af0c9 100644 --- a/content/en/getting-started/configuration.md +++ b/content/en/getting-started/configuration.md @@ -47,15 +47,15 @@ In addition to using a single site config file, one can use the `configDir` dire - Each file represents a configuration root object, such as `params.toml` for `[Params]`, `menu(s).toml` for `[Menu]`, `languages.toml` for `[Languages]` etc... - Each file's content must be top-level, for example: - In `config.toml` is: - ```toml - [Params] - foo = "bar" - ``` - In `params.toml` is: - ``` +{{< code-toggle file="config" >}} +[Params] foo = "bar" - ``` +{{< /code-toggle >}} + +{{< code-toggle file="params" >}} +foo = "bar" +{{< /code-toggle >}} + - Each directory holds a group of files containing settings unique to an environment. - Files can be localized to become language specific. @@ -325,6 +325,8 @@ useResourceCacheWhen writeStats {{< new-in "0.69.0" >}} : When enabled, a file named `hugo_stats.json` will be written to your project root with some aggregated data about the build, e.g. list of HTML entities published to be used to do [CSS pruning](/hugo-pipes/postprocess/#css-purging-with-postcss). If you're only using this for the production build, you should consider placing it below [config/production](/getting-started/configuration/#configuration-directory). It's also worth mentioning that, due to the nature of the partial server builds, new HTML entities will be added when you add or change them while the server is running, but the old values will not be removed until you restart the server or run a regular `hugo` build. +**Note** that the prime use case for this is purging of unused CSS; it is build for speed and there may be false positives (e.g. elements that isn't really a HTML element). + noJSConfigInAssets {{< new-in "0.78.0" >}} : Turn off writing a `jsconfig.json` into your `/assets` folder with mapping of imports from running [js.Build](https://gohugo.io/hugo-pipes/js). This file is intended to help with intellisense/navigation inside code editors such as [VS Code](https://code.visualstudio.com/). Note that if you do not use `js.Build`, no file will be written. @@ -444,15 +446,15 @@ To set config params, prefix the name with `HUGO_PARAMS_` Test and document setting params via JSON env var. {{< /todo >}} -## Ignore Content Files When Rendering +## Ignore Content and Data Files when Rendering -The following statement inside `./config.toml` will cause Hugo to ignore content files ending with `.foo` and `.boo` when rendering: +To exclude specific files from the content and data directories when rendering your site, set `ignoreFiles` to one or more regular expressions. -``` -ignoreFiles = [ "\\.foo$", "\\.boo$" ] -``` +For example, to ignore content and data files ending with `.foo` and `.boo`: -The above is a list of regular expressions. Note that the backslash (`\`) character is escaped in this example to keep TOML happy. +{{< code-toggle >}} +ignoreFiles = [ "\\.foo$","\\.boo$"] +{{< /code-toggle >}} ## Configure Front Matter @@ -463,20 +465,20 @@ Dates are important in Hugo, and you can configure how Hugo assigns dates to you The default configuration is: -```toml +{{< code-toggle file="config" >}} [frontmatter] date = ["date", "publishDate", "lastmod"] lastmod = [":git", "lastmod", "date", "publishDate"] publishDate = ["publishDate", "date"] expiryDate = ["expiryDate"] -``` +{{< /code-toggle >}} If you, as an example, have a non-standard date parameter in some of your content, you can override the setting for `date`: - ```toml +{{< code-toggle file="config" >}} [frontmatter] date = ["myDate", ":default"] -``` +{{< /code-toggle >}} The `:default` is a shortcut to the default settings. The above will set `.Date` to the date value in `myDate` if present, if not we will look in `date`,`publishDate`, `lastmod` and pick the first valid date. @@ -490,10 +492,10 @@ The special date handlers are: An example: - ```toml +{{< code-toggle file="config" >}} [frontmatter] lastmod = ["lastmod", ":fileModTime", ":default"] -``` +{{< /code-toggle >}} The above will try first to extract the value for `.Lastmod` starting with the `lastmod` front matter parameter, then the content file's modification timestamp. The last, `:default` should not be needed here, but Hugo will finally look for a valid date in `:git`, `date` and then `publishDate`. @@ -504,10 +506,10 @@ The above will try first to extract the value for `.Lastmod` starting with the ` An example: -```toml +{{< code-toggle file="config" >}} [frontmatter] date = [":filename", ":default"] -``` +{{< /code-toggle >}} The above will try first to extract the value for `.Date` from the filename, then it will look in front matter parameters `date`, `publishDate` and lastly `lastmod`. diff --git a/content/en/getting-started/quick-start.md b/content/en/getting-started/quick-start.md index f2378f4a7..6d8f2b1fc 100644 --- a/content/en/getting-started/quick-start.md +++ b/content/en/getting-started/quick-start.md @@ -65,13 +65,13 @@ First, download the theme from GitHub and add it to your site's `themes` directo ```bash cd quickstart git init -git submodule add https://github.com/budparr/gohugo-theme-ananke.git themes/ananke +git submodule add https://github.com/theNewDynamic/gohugo-theme-ananke.git themes/ananke ``` *Note for non-git users:* - If you do not have git installed, you can download the archive of the latest version of this theme from: - https://github.com/budparr/gohugo-theme-ananke/archive/master.zip + https://github.com/theNewDynamic/gohugo-theme-ananke/archive/master.zip - Extract that .zip file to get a "gohugo-theme-ananke-master" directory. - Rename that directory to "ananke", and move it into the "themes/" directory. @@ -163,7 +163,7 @@ Replace the `title` above with something more personal. Also, if you already hav **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/budparr/gohugo-theme-ananke). +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/).** diff --git a/content/en/getting-started/usage.md b/content/en/getting-started/usage.md index e35126fd0..2b41ecb45 100644 --- a/content/en/getting-started/usage.md +++ b/content/en/getting-started/usage.md @@ -183,15 +183,11 @@ Or... hugo server --disableLiveReload ``` -The latter flag can be omitted by adding the following key-value to your `config.toml` or `config.yml` file, respectively: +The latter flag can be omitted by adding the following: -``` +{{< code-toggle file="config" >}} disableLiveReload = true -``` - -``` -disableLiveReload: true -``` +{{< /code-toggle >}} ## Deploy Your Website diff --git a/content/en/hosting-and-deployment/hosting-on-gitlab.md b/content/en/hosting-and-deployment/hosting-on-gitlab.md index 0a40eb824..6634dbbe7 100644 --- a/content/en/hosting-and-deployment/hosting-on-gitlab.md +++ b/content/en/hosting-and-deployment/hosting-on-gitlab.md @@ -38,7 +38,7 @@ cd your-hugo-site In the root directory of your Hugo site, create a `.gitlab-ci.yml` file. The `.gitlab-ci.yml` configures the GitLab CI on how to build your page. Simply add the content below. {{< code file=".gitlab-ci.yml" >}} -image: monachus/hugo +image: registry.gitlab.com/pages/hugo:latest variables: GIT_SUBMODULE_STRATEGY: recursive @@ -53,6 +53,10 @@ pages: - master {{< /code >}} +{{% note %}} +All available Hugo versions are listed [here](https://gitlab.com/pages/hugo/container_registry) +{{% /note %}} + ## Push Your Hugo Website to GitLab Next, create a new repository on GitLab. It is *not* necessary to make the repository public. In addition, you might want to add `/public` to your .gitignore file, as there is no need to push compiled assets to GitLab or keep your output website in version control. diff --git a/content/en/hosting-and-deployment/hosting-on-netlify.md b/content/en/hosting-and-deployment/hosting-on-netlify.md index a04333d89..74c54b047 100644 --- a/content/en/hosting-and-deployment/hosting-on-netlify.md +++ b/content/en/hosting-and-deployment/hosting-on-netlify.md @@ -65,10 +65,10 @@ You can [set Hugo version](https://www.netlify.com/blog/2017/04/11/netlify-plus- For production: -``` +{{< code-toggle file="netlify" >}} [context.production.environment] HUGO_VERSION = "0.53" -``` +{{< /code-toggle >}} For testing: diff --git a/content/en/hugo-modules/use-modules.md b/content/en/hugo-modules/use-modules.md index db12964b4..e0d73957a 100644 --- a/content/en/hugo-modules/use-modules.md +++ b/content/en/hugo-modules/use-modules.md @@ -36,13 +36,13 @@ Also see the [CLI Doc](/commands/hugo_mod_init/). The easiest way to use a Module for a theme is to import it in the config. 1. Initialize the hugo module system: `hugo mod init github.com/