diff options
author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2022-12-20 11:04:41 +0100 |
---|---|---|
committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2022-12-20 11:04:41 +0100 |
commit | 9a215d6950e6705f9109497e9f38cc3844172612 (patch) | |
tree | f04e00c7c59f77214ee0c90ab95d5fcab40c25fa /docs/content/en | |
parent | eda1e720cd2434f97d7d931a7ff55447375e8d9a (diff) | |
parent | 41bc6f702aa54200530efbf4267e5c823df3028d (diff) |
Merge commit '41bc6f702aa54200530efbf4267e5c823df3028d'
Diffstat (limited to 'docs/content/en')
61 files changed, 281 insertions, 236 deletions
diff --git a/docs/content/en/about/benefits.md b/docs/content/en/about/benefits.md index e4fec5bb2..925da1732 100644 --- a/docs/content/en/about/benefits.md +++ b/docs/content/en/about/benefits.md @@ -27,11 +27,11 @@ This has many benefits. The most noticeable is performance. HTTP servers are *ve ## More on Static Site Generators -* ["An Introduction to Static Site Generators", David Walsh][] +* ["An Introduction to Static Site Generators", David Walsh] * ["Hugo vs. WordPress page load speed comparison: Hugo leaves WordPress in its dust", GettingThingsTech][hugovwordpress] -* ["Static Site Generators", O'Reilly][] -* [StaticGen: Top Open-Source Static Site Generators (GitHub Stars)][] -* ["Top 10 Static Website Generators", Netlify blog][] +* ["Static Site Generators", O'Reilly] +* [StaticGen: Top Open-Source Static Site Generators (GitHub Stars)] +* ["Top 10 Static Website Generators", Netlify blog] * ["The Resurgence of Static", dotCMS][dotcms] ["An Introduction to Static Site Generators", David Walsh]: https://davidwalsh.name/introduction-static-site-generators diff --git a/docs/content/en/about/features.md b/docs/content/en/about/features.md index 5e94de38c..fc3d5a030 100644 --- a/docs/content/en/about/features.md +++ b/docs/content/en/about/features.md @@ -17,42 +17,42 @@ toc: true ## General -* [Extremely fast][] build times (< 1 ms per page) +* [Extremely fast] build times (< 1 ms per page) * Completely cross platform, with [easy installation][install] on macOS, Linux, Windows, and more -* Renders changes on the fly with [LiveReload][] as you develop -* [Powerful theming][] +* Renders changes on the fly with [LiveReload] as you develop +* [Powerful theming] * [Host your site anywhere][hostanywhere] ## Organization -* Straightforward [organization for your projects][], including website sections -* Customizable [URLs][] -* Support for configurable [taxonomies][], including categories and tags -* [Sort content][] as you desire through powerful template [functions][] -* Automatic [table of contents][] generation -* [Dynamic menu][] creation -* [Pretty URLs][] support -* [Permalink][] pattern support -* Redirects via [aliases][] +* Straightforward [organization for your projects], including website sections +* Customizable [URLs] +* Support for configurable [taxonomies], including categories and tags +* [Sort content] as you desire through powerful template [functions] +* Automatic [table of contents] generation +* [Dynamic menu] creation +* [Pretty URLs] support +* [Permalink] pattern support +* Redirects via [aliases] ## Content -* Native Markdown and Emacs Org-Mode support, as well as other languages via *external helpers* (see [supported formats][]) -* TOML, YAML, and JSON metadata support in [front matter][] -* Customizable [homepage][] -* Multiple [content types][] -* Automatic and user defined [content summaries][] -* [Shortcodes][] to enable rich content inside of Markdown +* Native Markdown and Emacs Org-Mode support, as well as other languages via *external helpers* (see [supported formats]) +* TOML, YAML, and JSON metadata support in [front matter] +* Customizable [homepage] +* Multiple [content types] +* Automatic and user defined [content summaries] +* [Shortcodes] to enable rich content inside of Markdown * ["Minutes to Read"][pagevars] functionality * ["WordCount"][pagevars] functionality ## Additional Features -* Integrated [Disqus][] comment support -* Integrated [Google Analytics][] support -* Automatic [RSS][] creation -* Support for [Go][] HTML templates -* [Syntax highlighting][] powered by [Chroma][] +* Integrated [Disqus] comment support +* Integrated [Google Analytics] support +* Automatic [RSS] creation +* Support for [Go] HTML templates +* [Syntax highlighting] powered by [Chroma] [aliases]: /content-management/urls/#aliases [Chroma]: https://github.com/alecthomas/chroma diff --git a/docs/content/en/about/what-is-hugo.md b/docs/content/en/about/what-is-hugo.md index 01fac90c8..d61f821cd 100644 --- a/docs/content/en/about/what-is-hugo.md +++ b/docs/content/en/about/what-is-hugo.md @@ -17,9 +17,9 @@ aliases: [/overview/introduction/,/about/why-i-built-hugo/] toc: true --- -Hugo is a general-purpose website framework. Technically speaking, Hugo is a [static site generator][]. Unlike systems that dynamically build a page with each visitor request, Hugo builds pages when you create or update your content. Since websites are viewed far more often than they are edited, Hugo is designed to provide an optimal viewing experience for your website's end users and an ideal writing experience for website authors. +Hugo is a general-purpose website framework. Technically speaking, Hugo is a [static site generator]. Unlike systems that dynamically build a page with each visitor request, Hugo builds pages when you create or update your content. Since websites are viewed far more often than they are edited, Hugo is designed to provide an optimal viewing experience for your website's end users and an ideal writing experience for website authors. -Websites built with Hugo are extremely fast and secure. Hugo sites can be hosted anywhere, including [Netlify][], [Heroku][], [GoDaddy][], [DreamHost][], [GitHub Pages][], [GitLab Pages][], [Surge][], [Firebase][], [Google Cloud Storage][], [Amazon S3][], [Rackspace][], [Azure][], and [CloudFront][] and work well with CDNs. Hugo sites run without the need for a database or dependencies on expensive runtimes like Ruby, Python, or PHP. +Websites built with Hugo are extremely fast and secure. Hugo sites can be hosted anywhere, including [Netlify], [Heroku], [GoDaddy], [DreamHost], [GitHub Pages], [GitLab Pages], [Surge], [Firebase], [Google Cloud Storage], [Amazon S3], [Rackspace], [Azure], and [CloudFront] and work well with CDNs. Hugo sites run without the need for a database or dependencies on expensive runtimes like Ruby, Python, or PHP. We think of Hugo as the ideal website creation tool with nearly instant build times, able to rebuild whenever a change is made. diff --git a/docs/content/en/content-management/archetypes.md b/docs/content/en/content-management/archetypes.md index 31e229838..1d2ba3179 100644 --- a/docs/content/en/content-management/archetypes.md +++ b/docs/content/en/content-management/archetypes.md @@ -16,7 +16,7 @@ aliases: [/content/archetypes/] ## What are Archetypes? -**Archetypes** are content template files in the [archetypes directory][] of your project that contain preconfigured [front matter][] and possibly also a content disposition for your website's [content types][]. These will be used when you run `hugo new`. +**Archetypes** are content template files in the [archetypes directory] of your project that contain preconfigured [front matter] and possibly also a content disposition for your website's [content types]. These will be used when you run `hugo new`. The `hugo new` uses the `content-section` to find the most suitable archetype template in your project. If your project does not contain any archetype files, it will also look in the theme. diff --git a/docs/content/en/content-management/comments.md b/docs/content/en/content-management/comments.md index bb6a8d6ce..e49711e7c 100644 --- a/docs/content/en/content-management/comments.md +++ b/docs/content/en/content-management/comments.md @@ -29,7 +29,7 @@ Disqus comments require you set a single value in your [site's configuration fil disqusShortname = "yourDisqusShortname" {{</ code-toggle >}} -For many websites, this is enough configuration. However, you also have the option to set the following in the [front matter][] of a single content file: +For many websites, this is enough configuration. However, you also have the option to set the following in the [front matter] of a single content file: * `disqus_identifier` * `disqus_title` diff --git a/docs/content/en/content-management/front-matter.md b/docs/content/en/content-management/front-matter.md index 71e6e36ea..bf530518f 100644 --- a/docs/content/en/content-management/front-matter.md +++ b/docs/content/en/content-management/front-matter.md @@ -14,7 +14,7 @@ weight: 60 aliases: [/content/front-matter/] --- -**Front matter** allows you to keep metadata attached to an instance of a [content type][]---i.e., embedded inside a content file---and is one of the many features that gives Hugo its strength. +**Front matter** allows you to keep metadata attached to an instance of a [content type]---i.e., embedded inside a content file---and is one of the many features that gives Hugo its strength. {{< youtube Yh2xKRJGff4 >}} @@ -122,7 +122,7 @@ title : the title for the content. type -: the type of the content; this value will be automatically derived from the directory (i.e., the [section][]) if not specified in front matter. +: the type of the content; this value will be automatically derived from the directory (i.e., the [section]) if not specified in front matter. url : the full path to the content from the web root. It makes no assumptions about the path of the content file. See [URL Management](/content-management/urls/#set-url-in-front-matter). @@ -144,7 +144,7 @@ If neither `slug` nor `url` is present and [permalinks are not configured otherw You can add fields to your front matter arbitrarily to meet your needs. These user-defined key-values are placed into a single `.Params` variable for use in your templates. -The following fields can be accessed via `.Params.include_toc` and `.Params.show_comments`, respectively. The [Variables][] section provides more information on using Hugo's page- and site-level variables in your templates. +The following fields can be accessed via `.Params.include_toc` and `.Params.show_comments`, respectively. The [Variables] section provides more information on using Hugo's page- and site-level variables in your templates. {{< code-toggle copy="false" >}} include_toc: true diff --git a/docs/content/en/content-management/multilingual.md b/docs/content/en/content-management/multilingual.md index 4e4eba46e..5eb5506d9 100644 --- a/docs/content/en/content-management/multilingual.md +++ b/docs/content/en/content-management/multilingual.md @@ -220,10 +220,6 @@ slug: "a-propos" At render, Hugo will build both `/about/` and `/fr/a-propos/` while maintaining their translation linking. -{{% note %}} -If using `url`, remember to include the language part as well: `/fr/compagnie/a-propos/`. -{{%/ note %}} - ### Page Bundles To avoid the burden of having to duplicate files, each Page Bundle inherits the resources of its linked translated pages' bundles except for the content files (Markdown files, HTML files etc...). diff --git a/docs/content/en/content-management/organization/index.md b/docs/content/en/content-management/organization/index.md index b677d8c18..94c0cfd5a 100644 --- a/docs/content/en/content-management/organization/index.md +++ b/docs/content/en/content-management/organization/index.md @@ -33,7 +33,7 @@ The bundle documentation is a **work in progress**. We will publish more compreh In Hugo, your content should be organized in a manner that reflects the rendered website. -While Hugo supports content nested at any level, the top levels (i.e. `content/<DIRECTORIES>`) are special in Hugo and are considered the content type used to determine layouts etc. To read more about sections, including how to nest them, see [sections][]. +While Hugo supports content nested at any level, the top levels (i.e. `content/<DIRECTORIES>`) are special in Hugo and are considered the content type used to determine layouts etc. To read more about sections, including how to nest them, see [sections]. Without any additional configuration, the following will automatically work: @@ -59,7 +59,7 @@ The following demonstrates the relationships between your content organization a ### Index Pages: `_index.md` -`_index.md` has a special role in Hugo. It allows you to add front matter and content to your [list templates][lists]. These templates include those for [section templates][], [taxonomy templates][], [taxonomy terms templates][], and your [homepage template][]. +`_index.md` has a special role in Hugo. It allows you to add front matter and content to your [list templates][lists]. These templates include those for [section templates], [taxonomy templates], [taxonomy terms templates], and your [homepage template]. {{% note %}} **Tip:** You can get a reference to the content and metadata in `_index.md` using the [`.Site.GetPage` function](/functions/getpage/). diff --git a/docs/content/en/content-management/sections.md b/docs/content/en/content-management/sections.md index 4335f137d..5ff884610 100644 --- a/docs/content/en/content-management/sections.md +++ b/docs/content/en/content-management/sections.md @@ -86,11 +86,11 @@ Also see [Page Variables](/variables/page/). ## Content Section Lists -Hugo will automatically create a page for each *root section* that lists all the content in that section. See the documentation on [section templates][] for details on customizing the way these pages are rendered. +Hugo will automatically create a page for each *root section* that lists all the content in that section. See the documentation on [section templates] for details on customizing the way these pages are rendered. ## Cont |