From d8c64b2d2046c226b209ad69deaf7ab2b91d316d Mon Sep 17 00:00:00 2001 From: Ryan Watters Date: Thu, 23 Feb 2017 17:26:20 -0600 Subject: [PATCH] Make more copy edits to customizing themes tutorial --- content-changes.md | 1 + content/about-hugo/benefits-of-static.md | 6 +- content/about-hugo/roadmap.md | 15 +- content/content-management/url-management.md | 41 +- .../contribute-to-the-hugo-docs.md | 8 +- .../developer-tools/syntax-highlighting.md | 2 +- content/functions/truncate.md | 18 + content/getting-started/configuration.md | 8 +- content/getting-started/quick-start.md | 1 + content/showcase/arresteddevops.md | 1 + content/templates/lists-in-hugo.md | 12 +- content/templates/section-templates.md | 176 ++-- content/themes/customizing-a-theme.md | 59 +- .../tutorials/creating-a-multilingual-site.md | 1 + content/tutorials/creating-a-new-theme.md | 789 +++++++----------- .../tutorials/migrate-from-jekyll-to-hugo.md | 1 + ...d-hugo-variables.md => other-variables.md} | 19 +- .../variables-and-params/page-variables.md | 2 +- layouts/shortcodes/input.html | 13 +- layouts/shortcodes/lookupexplanation.html | 2 +- themes/hugodocs/layouts/_default/single.html | 2 +- ....html => lookup-explanation-markdown.html} | 2 +- 22 files changed, 529 insertions(+), 650 deletions(-) create mode 100644 content/functions/truncate.md rename content/variables-and-params/{shortcode-git-and-hugo-variables.md => other-variables.md} (97%) rename themes/hugodocs/layouts/partials/{lookup-explanation.html => lookup-explanation-markdown.html} (75%) diff --git a/content-changes.md b/content-changes.md index 9fb5d91db..6c7e093c5 100644 --- a/content-changes.md +++ b/content-changes.md @@ -51,6 +51,7 @@ This is no longer a site navigation link and is instead a button along with "Fil * "Tutorials" is not an intuitive place for end-users to look for this kind of documentation * All content moved from `/tutorials` edited to reflect a less tutorial-ish style of language (e.g., remove of lines starting with "In this tutorial...") * Aliases added to new pages and in-page links updated throughout +* Michael Henderson's "Creating a Theme" website ([current][],[concept][]) has been copy edited and content edited to include the new code block shortcodes. ### Troubleshooting diff --git a/content/about-hugo/benefits-of-static.md b/content/about-hugo/benefits-of-static.md index 4698a60d3..afe92db6a 100644 --- a/content/about-hugo/benefits-of-static.md +++ b/content/about-hugo/benefits-of-static.md @@ -1,5 +1,5 @@ --- -title: The Benefits of Static +title: The Benefits of Static Site Generators linktitle: The Benefits of Static description: Learn why static site generators have become such a popular option for developers. Benefits include performance, security, ease of use, and exportability of content. date: 2017-02-01 @@ -20,9 +20,7 @@ To prevent unnecessary delays in delivering pages to end users, dynamic site gen Hugo and other static site generators take caching a step further. All HTML files are rendered on your computer. You can review the files before you copy them to the computer hosting the HTTP server. Since the HTML files aren't generated dynamically, we say that Hugo is a "static site generator." -Not running a website generator on your HTTP server has many benefits. The most noticeable is performance---HTTP servers are very good at -sending files. So good that you can effectively serve the same number -of pages with a fraction of the memory and CPU needed for a dynamic site. +Not running a website generator on your HTTP server has many benefits. The most noticeable is performance---HTTP servers are very good at sending files. So good that you can effectively serve the same number of pages with a fraction of the memory and CPU needed for a dynamic site. ## Resources on Static Site Generators diff --git a/content/about-hugo/roadmap.md b/content/about-hugo/roadmap.md index 224feaca7..3bac4e491 100644 --- a/content/about-hugo/roadmap.md +++ b/content/about-hugo/roadmap.md @@ -18,26 +18,27 @@ In no particular order, here is what is currently being worked on for the Hugo p * Intelligently related posts ({{< gh 98 >}}) * Even easier deployment to S3, SSH, GitHub, rsync. Give the [hosting and deployment][] section a shot. -* Import from other website systems. There are already [existing migration tools][], but they don’t cover all major platforms. +* Import from other website systems. There are already [existing migration tools][migrate], but they don’t cover all major platforms. * An interactive web-based editor (See the [related Discuss thread][]) * Additional [themes][], which are always ongoing and contributions are welcome! * Dynamic image resizing via shortcodes ({{< gh 1014 >}}) * Native support for additional content formats (AsciiDoc {{< gh 1435>}}, reST {{< gh 1436 >}}) -* And, last but not least, [*your* best ideas!][] +* And, last but not least, [***your*** best ideas!][] ## Contributions Welcome -Feel free to [contribute][] or [open a new issue][] if you have an idea for a new feature. +Feel free to [contribute to Hugo's development][devcontribute], [improve Hugo's documentation][doccontribute], or [open a new issue][newissue] if you have an idea for a new feature. [#98]: https://github.com/spf13/hugo/issues/98 [#1014]: https://github.com/spf13/hugo/issues/1014 [#1435]: https://github.com/spf13/hugo/issues/1435 [#1436]: https://github.com/spf13/hugo/issues/1436 -[contribute]: /contribute-to-hugo/ +[devcontribute]: /contribute-to-hugo/contribute-to-hugo-development/ +[doccontribute]: /contribute-to-hugo/contribute-to-the-hugo-docs/ [hosting and deployment]: /hosting-and-deployment/ -[existing migration tools]: /developer-tools/migrate-to-hugo/ -[open a new issue]: https://github.com/spf13/hugo/issues/ +[migrate]: /developer-tools/migrate-to-hugo/ +[newissue]: https://github.com/spf13/hugo/issues/ [related Discuss thread]: https://discuss.gohugo.io/t/web-based-editor/155 [themes]: /themes/ [tutorials]: /tutorials -[*your* best ideas!]: /contribute-to-hugo/ \ No newline at end of file +[***your*** best ideas!]: /contribute-to-hugo/ \ No newline at end of file diff --git a/content/content-management/url-management.md b/content/content-management/url-management.md index bf149a06e..67e97805d 100644 --- a/content/content-management/url-management.md +++ b/content/content-management/url-management.md @@ -53,12 +53,6 @@ The following is a list of values that can be used in a `permalink` definition i * `:slug` = the content's slug (or title if no slug) * `:filename` = the content's filename (without extension) -## Aliases - -For people migrating existing published content to Hugo, there's a good chance you need a mechanism to handle redirecting old URLs. - -Luckily, redirects can be handled easily with _aliases_ in Hugo. - ## Example Given a post on your current Hugo site, with a path of: @@ -116,7 +110,13 @@ aliases: --- ``` -## How Hugo Aliases Work +## Aliases + +For people migrating existing published content to Hugo, there's a good chance you need a mechanism to handle redirecting old URLs. + +Luckily, redirects can be handled easily with _aliases_ in Hugo. + +### How Hugo Aliases Work When aliases are specified, Hugo creates a physical folder structure to match the alias entry, and, an html file specifying the canonical URL for the page, and a redirect target. @@ -136,20 +136,31 @@ Assuming a baseURL of `mysite.tld`, the contents of the html file will look some The `http-equiv="refresh"` line is what performs the redirect, in 0 seconds in this case. -## Customizing +### Customizing You may customize this alias page by creating an alias.html template in the -layouts folder of your site. In this case, the data passed to the template is +layouts folder of your site. In this case, the data passed to the template is -* Permalink - the link to the page being aliased -* Page - the Page data for the page being aliased +`Permalink` +: the link to the page being aliased + +`Page` +: the Page data for the page being aliased ## Pretty URLs -By default, Hugo renders your content with "pretty" URLs. For example, -content created at `/content/extras/urls.md` will be rendered at -`/public/extras/urls/index.html` according to Hugo's default behavior after running the `hugo` CLI build command. No non-standard server-side -configuration is required for these pretty URLs to work. +Hugo's default behavior is to render your content with "pretty" URLs. No non-standard server-side configuration is required for these pretty URLs to work. + +The following demonstrates the concept: + +```bash +content/posts/_index.md +=> yoursite.com/posts/index.html +content/posts/post-1.md +=> yoursite.com/ +content/posts/post-2.md +content/posts/post-3.md +``` ## Ugly URLs diff --git a/content/contribute-to-hugo/contribute-to-the-hugo-docs.md b/content/contribute-to-hugo/contribute-to-the-hugo-docs.md index 1acef3b10..2d376056e 100644 --- a/content/contribute-to-hugo/contribute-to-the-hugo-docs.md +++ b/content/contribute-to-hugo/contribute-to-the-hugo-docs.md @@ -146,7 +146,11 @@ This is a warning, which should be reserved for *important* information like bre It's more important to contribute *some* documentation than no documentation at all. We need your help! {{% /note %}} -The Hugo docs are not especially prescriptive in terms of grammar and usage. We encourage everyone to contribute, regardless of your writing style. That said, here are a few pointers to help the project maintain more consistency: +The Hugo docs are not especially prescriptive in terms of grammar and usage. We encourage everyone to contribute, regardless of your writing style. That said, here are a few gotchas when writing your documentation that, if observed, will create a more consistent documentation experience: + +1. *Front matter* is two words. +2. *Homepage* is one word. +3. Be sure to add a `godocref` whenever possible to a new content file's front matter. We want to promote Hugo *and* Golang by demonstrating the inseparable wedding of the two. ## How Content is Ordered in the Docs @@ -154,7 +158,7 @@ The Hugo docs are not especially prescriptive in terms of grammar and usage. We ## Be Mindful of Aliases -Use aliases sparingly. The following table shows a list of all the aliases used in the Hugo Docs. If you need to use an alias in your new content file's front matter, be sure to check here first. +Use aliases sparingly. The following table shows a list of all the aliases used in the Hugo Docs. If you need to use an alias in your new content file's front matter, be sure to check here first to prevent conflicts. {{< allaliases >}} diff --git a/content/developer-tools/syntax-highlighting.md b/content/developer-tools/syntax-highlighting.md index 2f739365a..387fc0e2b 100644 --- a/content/developer-tools/syntax-highlighting.md +++ b/content/developer-tools/syntax-highlighting.md @@ -105,7 +105,7 @@ The keywords in the `highlight` shortcode mirror those of Pygments from the comm It is also possible to add syntax highlighting with GitHub flavored code fences. To enable this, set the `PygmentsCodeFences` to `true` in Hugo's [configuration file](/getting-started/configuration/); ```` -``` html +```html

{{ .Title }}

diff --git a/content/functions/truncate.md b/content/functions/truncate.md new file mode 100644 index 000000000..3dc74b01c --- /dev/null +++ b/content/functions/truncate.md @@ -0,0 +1,18 @@ +--- +title: truncate +linktitle: truncate +description: +godocref: +date: 2017-02-01 +publishdate: 2017-02-01 +lastmod: 2017-02-01 +categories: [functions] +tags: [] +toc: false +draft: false +aliases: [] +--- + +Truncate a text to a max length without cutting words or leaving unclosed HTML tags. Since Go templates are HTML-aware, truncate will handle normal strings vs HTML strings intelligently. It's important to note that if you have a raw string that contains HTML tags that you want treated as HTML, you will need to convert the string to HTML using the safeHTML template function before sending the value to truncate; otherwise, the HTML tags will be escaped by truncate. + +`{{ "Keep my HTML" | safeHTML | truncate 10 }}` → `Keep my …` \ No newline at end of file diff --git a/content/getting-started/configuration.md b/content/getting-started/configuration.md index 91e8b96c5..9968e9f19 100644 --- a/content/getting-started/configuration.md +++ b/content/getting-started/configuration.md @@ -135,6 +135,8 @@ pygmentsCodeFencesGuessSyntax: false pygmentsStyle: "monokai" # true use pygments-css or false will color code directly pygmentsUseClasses: false +# maximum number of items in the RSS feed +rssLimit: 15 # see "Section Menu for Lazy Bloggers", /templates/menu-templates for more info SectionPagesMenu: "" # default sitemap configuration map @@ -247,7 +249,9 @@ layoutDir = "layouts" # Enable Logging log = false # Log File path (if set, logging enabled automatically) -logFile = "" +logFile = +# maximum number of items in the RSS feed +rssLimit = 15 # "toml","yaml", or "json" metaDataFormat = "toml" newContentEditor = "" @@ -272,6 +276,8 @@ pygmentsCodeFencesGuessSyntax = false pygmentsStyle = "monokai" # true: use pygments-css or false: color-codes directly pygmentsUseClasses = false +# maximum number of items in the RSS feed +rssLimit: 15 # see "Section Menu for Lazy Bloggers", /templates/menu-templates for more info SectionPagesMenu = # default sitemap configuration map diff --git a/content/getting-started/quick-start.md b/content/getting-started/quick-start.md index 3b76c9907..e8373e443 100644 --- a/content/getting-started/quick-start.md +++ b/content/getting-started/quick-start.md @@ -49,6 +49,7 @@ You can check your `hugo version` as well: ```bash hugo version ``` + ``` Hugo Static Site Generator v0.18.1 BuildDate: 2016-12-30T05:02:43-05:00 ``` diff --git a/content/showcase/arresteddevops.md b/content/showcase/arresteddevops.md index 7ae0cccad..9ce9de925 100644 --- a/content/showcase/arresteddevops.md +++ b/content/showcase/arresteddevops.md @@ -12,3 +12,4 @@ tags: image: arresteddevops.png title: arresteddevops --- + diff --git a/content/templates/lists-in-hugo.md b/content/templates/lists-in-hugo.md index 2ac89908b..ffc17082a 100644 --- a/content/templates/lists-in-hugo.md +++ b/content/templates/lists-in-hugo.md @@ -28,21 +28,15 @@ Hugo uses the term *list* in its truest sense: a sequential arrangement of mater Since section lists and taxonomy lists (N.B., *not* [taxonomy terms lists][]) are both *lists* with regards to their templates, both of these templates have the same terminating default of `_default/list.html`---or `themes/mytheme/layouts/_default/list.html` in the case of a themed project---in their *lookup orders*. In addition, both [section lists][sections] and [taxonomy lists][taxonomies] have their own default list templates in `_default`: - - #### Default Section Templates 1. `layouts/section/sectionname.html` ### Understanding `.Data.Pages` - - - - - - - +{{% note "The Confusion over `.Data`" %}} +**Mention something here about the difference between .Data.Pages and .Site.Data maybe?** +{{% /note %}} [homepage]: /templates/homepage-template/ diff --git a/content/templates/section-templates.md b/content/templates/section-templates.md index 156bedcba..3907e6197 100644 --- a/content/templates/section-templates.md +++ b/content/templates/section-templates.md @@ -18,8 +18,6 @@ needsreview: true {{< lookupexplanation >}} - - ## Lookup Order for Section Page Templates Hugo uses a set of rules to figure out which template to use when rendering a specific page. @@ -232,19 +230,23 @@ The below example sorts a list of posts by their rating. If the frontmatter field of interest is nested beneath another field, you can also get it: - {{ range (.Date.Pages.ByParam "author.last_name") }} - - {{ end }} +``` +{{ range (.Date.Pages.ByParam "author.last_name") }} + +{{ end }} +``` ### Reverse Order Can be applied to any of the above. Using Date for an example. - {{ range .Data.Pages.ByDate.Reverse }} -
  • - {{ .Title }} -
    {{ .Date.Format "Mon, Jan 2, 2006" }}
    -
  • - {{ end }} +``` +{{ range .Data.Pages.ByDate.Reverse }} +
  • +{{ .Title }} +
    {{ .Date.Format "Mon, Jan 2, 2006" }}
    +
  • +{{ end }} +``` ## Grouping Content @@ -256,73 +258,83 @@ your list templates: ### Grouping by Page field - {{ range .Data.Pages.GroupBy "Section" }} -

    {{ .Key }}

    -
      - {{ range .Pages }} -
    • - {{ .Title }} -
      {{ .Date.Format "Mon, Jan 2, 2006" }}
      -
    • - {{ end }} -
    +``` +{{ range .Data.Pages.GroupBy "Section" }} +

    {{ .Key }}

    +
      + {{ range .Pages }} +
    • + {{ .Title }} +
      {{ .Date.Format "Mon, Jan 2, 2006" }}
      +
    • {{ end }} +
    +{{ end }} +``` ### Grouping by Page date - {{ range .Data.Pages.GroupByDate "2006-01" }} -

    {{ .Key }}

    -
      - {{ range .Pages }} -
    • - {{ .Title }} -
      {{ .Date.Format "Mon, Jan 2, 2006" }}
      -
    • - {{ end }} -
    +``` +{{ range .Data.Pages.GroupByDate "2006-01" }} +

    {{ .Key }}

    +
      + {{ range .Pages }} +
    • + {{ .Title }} +
      {{ .Date.Format "Mon, Jan 2, 2006" }}
      +
    • {{ end }} +
    +{{ end }} +``` ### Grouping by Page publish date - {{ range .Data.Pages.GroupByPublishDate "2006-01" }} -

    {{ .Key }}

    -
      - {{ range .Pages }} -
    • - {{ .Title }} -
      {{ .PublishDate.Format "Mon, Jan 2, 2006" }}
      -
    • - {{ end }} -
    +``` +{{ range .Data.Pages.GroupByPublishDate "2006-01" }} +

    {{ .Key }}

    +
      + {{ range .Pages }} +
    • + {{ .Title }} +
      {{ .PublishDate.Format "Mon, Jan 2, 2006" }}
      +
    • {{ end }} +
    +{{ end }} +``` ### Grouping by Page param - {{ range .Data.Pages.GroupByParam "param_key" }} -

    {{ .Key }}

    -
      - {{ range .Pages }} -
    • - {{ .Title }} -
      {{ .Date.Format "Mon, Jan 2, 2006" }}
      -
    • - {{ end }} -
    +```html +{{ range .Data.Pages.GroupByParam "param_key" }} +

    {{ .Key }}

    +
      + {{ range .Pages }} +
    • + {{ .Title }} +
      {{ .Date.Format "Mon, Jan 2, 2006" }}
      +
    • {{ end }} +
    +{{ end }} +``` ### Grouping by Page param in date format - {{ range .Data.Pages.GroupByParamDate "param_key" "2006-01" }} -

    {{ .Key }}

    -
      - {{ range .Pages }} -
    • - {{ .Title }} -
      {{ .Date.Format "Mon, Jan 2, 2006" }}
      -
    • - {{ end }} -
    +```html +{{ range .Data.Pages.GroupByParamDate "param_key" "2006-01" }} +

    {{ .Key }}

    +
      + {{ range .Pages }} +
    • + {{ .Title }} +
      {{ .Date.Format "Mon, Jan 2, 2006" }}
      +
    • {{ end }} +
    +{{ end }} +``` ### Reversing Key Order @@ -335,20 +347,24 @@ it’s really just a matter of preference. #### Reverse method - {{ range (.Data.Pages.GroupBy "Section").Reverse }} - ... +```golang +{{ range (.Data.Pages.GroupBy "Section").Reverse }} +``` - {{ range (.Data.Pages.GroupByDate "2006-01").Reverse }} - ... +```golang +{{ range (.Data.Pages.GroupByDate "2006-01").Reverse }} +``` #### Providing the (alternate) direction - {{ range .Data.Pages.GroupByDate "2006-01" "asc" }} - ... +```golang +{{ range .Data.Pages.GroupByDate "2006-01" "asc" }} +``` - {{ range .Data.Pages.GroupBy "Section" "desc" }} - ... +```golang +{{ range .Data.Pages.GroupBy "Section" "desc" }} +``` ### Ordering Pages within Group @@ -357,17 +373,19 @@ Because Grouping returns a key and a slice of pages, all of the ordering methods In this example, I’ve ordered the groups in chronological order and the content within each group in alphabetical order by title. - {{ range .Data.Pages.GroupByDate "2006-01" "asc" }} -

    {{ .Key }}

    -
      - {{ range .Pages.ByTitle }} -
    • - {{ .Title }} -
      {{ .Date.Format "Mon, Jan 2, 2006" }}
      -
    • - {{ end }} -
    +```html +{{ range .Data.Pages.GroupByDate "2006-01" "asc" }} +

    {{ .Key }}

    +
      + {{ range .Pages.ByTitle }} +
    • + {{ .Title }} +
      {{ .Date.Format "Mon, Jan 2, 2006" }}
      +
    • {{ end }} +
    +{{ end }} +``` ## Filtering & Limiting Content diff --git a/content/themes/customizing-a-theme.md b/content/themes/customizing-a-theme.md index 33a7b591b..de3ce5b9b 100644 --- a/content/themes/customizing-a-theme.md +++ b/content/themes/customizing-a-theme.md @@ -10,27 +10,41 @@ tags: [themes, source, organization, directories] weight: 20 draft: false aliases: [/themes/customizing/,/themes/customize/] -toc: false +toc: true needsreview: true --- -_The following are key concepts for Hugo site customization. Hugo permits you to **supplement or override** any theme template or static file, with files in your working directory._ +## Introduction -_When you use a theme cloned from its git repository, you do not edit the theme's files directly. Rather, you override them as per the following:_ +The following are key concepts for Hugo site customization. Hugo permits you to supplement *or* override any theme template or static file, with files in your working directory. -## Replace Static Files +{{% note %}} +When you use a theme cloned from its git repository, do not edit the theme's files directly. Instead, theme customization in Hugo is a matter of *overriding* the templates made available to you in a theme. This provides the added flexibility of tweaking a theme to meet your needs while staying current with a theme's upstream. +{{% /note %}} -For including a different file than what the theme ships with. For example, if you would like to use a more recent version of jQuery than what the theme happens to include, simply place an identically-named file in the same relative location but in your working directory. +## Understanding the Theme Lookup Order -For example, if the theme has jQuery 1.6 in: +{{< lookupexplanation >}} - /themes/themename/static/js/jquery.min.js +## Replacing Static Files -... you would simply place your file in the same relative path, but in the root of your working folder: +There are times where you want to include static assets that differ from versions of the same asset that ships with a theme. For example, if you would like to use a more recent version of jQuery than what the theme happens to include, simply place an identically-named file in the same relative location but in your working directory. - /static/js/jquery.min.js +Let's assume the theme you are using has jQuery 1.8 in the following location: -## Replace a single template file +```bash +/themes/mytheme/static/js/jquery.min.js +``` + +You want to replace jQuery with jQuery 1.7. The easiest way to do this is to replace the file *with a file of the same name* in the same relative path in your project's root. + +So, to replace jQuery 1.7 from the theme, take your version of jQuery (e.g., `jquery-3.1.1.js`), change the file name so that it is *identical* to the theme file you are trying to use (`jquery.min.js`) and place it here: + +```bash +/static/js/jquery.min.js +``` + +## Replacing Template Files Anytime Hugo looks for a matching template, it will first check the working directory before looking in the theme directory. If you would like to modify a template, simply create that template in your local `layouts` directory. @@ -40,21 +54,26 @@ This is especially helpful when the theme creator used [partial templates](/temp For example: - /themes/themename/layouts/_default/single.html +```bash +/themes/themename/layouts/_default/single.html +``` -... would be overridden by: +Would be overwritten by - /layouts/_default/single.html +```bash +/layouts/_default/single.html +``` -**Warning**: This only works for templates that Hugo "knows about" (that follow its convention for folder structure and naming). If the theme imports template files in a creatively-named directory, Hugo won’t know to look for the local `/layouts` first. +{{% warning %}} +This only works for templates that Hugo "knows about" (i.e., that follow its convention for folder structure and naming). If a theme imports template files in a creatively named directory, Hugo won’t know to look for the local `/layouts` first. +{{% /warning %}} -## Replace an archetype +## Replace an Archetype If the archetype that ships with the theme for a given content type (or all content types) doesn’t fit with how you are using the theme, feel free to copy it to your `/archetypes` directory and make modifications as you see fit. -## Beware of the default - -**Default** is a very powerful force in Hugo, especially as it pertains to overwriting theme files. If a default is located in the local archetype directory or `/layouts/_default/` directory, it will be used instead of any of the similar files in the theme. - -It is usually better to override specific files rather than using the default in your working directory. +{{% warning "Beware of `layouts/_default`" %}} +The `_default` directory is a very powerful force in Hugo, especially as it pertains to overwriting theme files. If a default file is located in the local [archetype](/content-management/archetypes/) or layout directory (i.e., `archetypes/default.md` or `/layouts/_default/*.html`, respectively), it will override the file of the same name in the corresponding theme directory (i.e., `themes//archetypes/default.md` or `themes//layout/_defaults/*.html`, respectively). +It is usually better to override specific files; i.e. rather than using `layouts/_default/*.html` in your working directory. +{{% /warning %}} \ No newline at end of file diff --git a/content/tutorials/creating-a-multilingual-site.md b/content/tutorials/creating-a-multilingual-site.md index 1272b37ca..596949197 100644 --- a/content/tutorials/creating-a-multilingual-site.md +++ b/content/tutorials/creating-a-multilingual-site.md @@ -11,6 +11,7 @@ tags: [internationalization,multilingual,i18n,tutorials] authors: ["Rick Cogley"] aliases: [/tutorials/create-a-multilingual-site/] draft: false +hugoversion: 16 needsreview: true --- diff --git a/content/tutorials/creating-a-new-theme.md b/content/tutorials/creating-a-new-theme.md index 1e0fa3e99..d5e921ba9 100644 --- a/content/tutorials/creating-a-new-theme.md +++ b/content/tutorials/creating-a-new-theme.md @@ -9,20 +9,28 @@ categories: [tutorials] tags: [themes] authors: ["Michael Henderson"] aliases: [] +hugoversion: 18.1 draft: false +toc: true needsreview: true -outdated: true --- ## Introduction This tutorial will show you how to create a simple theme in Hugo. -I'll introduce Hugo's use of templates, and explain how to organize them into a theme. The theme will grow, minimizing effort while meeting evolving needs. To promote this focus, and to keep everything simple, I'll omit CSS styling. +I'll introduce Hugo's use of templates and explain how to organize them into a theme. The theme will grow, minimizing effort while meeting evolving needs. To promote this focus, and to keep everything simple, I'll omit CSS styling. We'll start by creating a tiny, blog-like website. We'll implement this blog with just one — quite basic — template. Then we'll add an About page, and a few articles. Overall, this website (along with what you learn here) will provide a good basis for you to continue working with Hugo in the future. By making small variations, you'll be able to create many different kinds of websites. -I will assume you're comfortable with HTML, Markdown formatting, and the Bash command line (possibly using [Git for Windows](https://git-for-windows.github.io/)). +## Assumptions + +This tutorial assumes you are comfortable in the following: + +* HTML +* Markdown syntax +* Using a text editor +* Bash command line (or possibly [Git for Windows][gitwindows]) A few symbols might call for explanation: in this tutorial, the commands you'll enter will be preceded by a `$` prompt — and their output will follow. `vi` means to open your editor; then `:wq` means to save the file. Sometimes I'll add comments to explain a point — these start with `#`. @@ -34,7 +42,9 @@ $ echo this is a command this is a command # edit the file + $ vi foo.md + +++ date = "2040-01-18" title = "creating a new theme" @@ -52,197 +62,111 @@ title = "creating a new theme" +++ Bah! Humbug! ``` + ## Definitions -Three concepts: +Three following are essential for creating your first Hugo theme, as well as your first Hugo website: 1. _Non-content_ files; 2. _Templates_ (as Hugo defines them); and -3. _Front-matter_ +3. _Front matter_ -are essential for creating your first Hugo theme, -as well as your first Hugo website. ### Non-Content -The source files of a website (destined to be rendered by Hugo) -are divided into two kinds: +The source files of a website (destined to be rendered by Hugo) are divided into two kinds: 1. The files containing its textual content (and nothing else — -except Hugo front-matter: see below, and Markdown styling); and +except Hugo front matter: see below, and Markdown styling); and 2. All other files. (These contain ***no*** textual content — ideally.) -Temporarily, let's affix the adjective _non-content_ -to the latter kind of source files. +Temporarily, let's affix the adjective _non-content_ to the latter kind of source files. -Non-content files are responsible for your website's look and feel. -(Follow these article links from [Bop -Design](https://www.bopdesign.com/bop-blog/2013/11/what-is-the-look-and-feel-of-a-website-and-why-its-important/) -and -[Wikipedia](https://en.wikipedia.org/w/index.php?title=Look_and_feel&oldid=731052704) -if you wish for more information.) -They comprise its images, its CSS (for the sizes, colors and fonts), -its JavaScript (for the actions and reactions), and its Hugo templates +Non-content files are responsible for your website's look and feel. (Follow these article links from [BopDesign](https://www.bopdesign.com/bop-blog/2013/11/what-is-the-look-and-feel-of-a-website-and-why-its-important/) +and [Wikipedia](https://en.wikipedia.org/w/index.php?title=Look_and_feel&oldid=731052704) if you wish for more information.) They comprise its images, its CSS (for the sizes, colors and fonts), its JavaScript (for the actions and reactions), and its Hugo templates (which contain the rules Hugo uses to transform your content into HTML). -Given these files, Hugo will render a static website — -informed by your content — -which contains the above images, HTML, CSS and JavaScript, -ready to be served to visitors. +Given these files, Hugo will render a static website—informed by your content—which contains the above images, HTML, CSS and JavaScript, ready to be served to visitors. + +Actually, a few of your invariant textual snippets could reside in non-content files as well. However, because someone might reuse your theme (eventually), preferably you should keep those textual snippets in their own content files. -Actually, a few of your invariant textual snippets -could reside in non-content files as well. -However, because someone might reuse your theme (eventually), -preferably you should keep those textual snippets in their own content files. #### Where -Regarding where to create your non-content files, you have two options. -The simplest is the `./layouts/` and `./static/` filesystem trees. -If you choose this way, -then you needn't worry about configuring Hugo to find them. -Invariably, these are the first two places Hugo seeks for templates -(as well as images, CSS and JavaScript); -so in that case, it's guaranteed to find all your non-content files. +Regarding where to create your non-content files, you have two options. The simplest is the `./layouts/` and `./static/` filesystem trees. If you choose this way, then you needn't worry about configuring Hugo to find them. Invariably, these are the first two places Hugo seeks for templates (as well as images, CSS and JavaScript); so in that case, it's guaranteed to find all your non-content files. + +The second option is to create them in a filesystem tree located somewhere under the `./themes/` directory. If you choose that way, then you must always tell Hugo where to search for them—that's extra work, though. So, why bother? -The second option is to create them in a filesystem tree -located somewhere under the `./themes/` directory. -If you choose that way, -then you must always tell Hugo where to search for them — -that's extra work, though. So, why bother? #### Theme -Well — the difference between creating your non-content files under -`./layouts/` and `./static/` and creating them under `./themes/` -is admittedly very subtle. -Non-content files created under `./layouts/` and `./static/` -cannot be customized without editing them directly. -On the other hand, non-content files created under `./themes/` -can be customized, in another way. That way is both conventional -(for Hugo websites) and non-destructive. Therefore, -creating your non-content files under `./themes/` -makes it easier for other people to use them. +Well, the difference between creating your non-content files under `./layouts/` and `./static/` and creating them under `./themes/` is admittedly very subtle. Non-content files created under `./layouts/` and `./static/` cannot be customized without editing them directly. On the other hand, non-content files created under `./themes/` can be customized, in another way. That way is both conventional (for Hugo websites) and non-destructive. Therefore, creating your non-content files under `./themes/` makes it easier for other people to use them. -The rest of this tutorial will call a set of non-content files a ***theme*** -if they comprise a filesystem tree rooted anywhere under the -`./themes/` directory. +The rest of this tutorial will call a set of non-content files a ***theme*** if they comprise a filesystem tree rooted anywhere under the `./themes/` directory. + +Note that you can use this tutorial to create your set of non-content files under `./layouts/` and `./static/` if you wish. The only difference is that you wouldn't need to edit your website's configuration file in order to select a theme. -Note that you can use this tutorial to create your set of non-content files -under `./layouts/` and `./static/` if you wish. The only difference is that -you wouldn't need to edit your website's configuration file -in order to select a theme. ### Home -The home page, or landing page, -is the first page that many visitors to a website will see. -Often this is `/index.html`, located at the root URL of the website. -Since Hugo writes files into the `./public/` tree, -your home page will reside in file `./public/index.html`. +The home page, or landing page, is the first page that many visitors to a website will see. Often this is `/index.html`, located at the root URL of the website. Since Hugo writes files into the `./public/` tree, your home page will reside in file `./public/index.html`. + ### Configure -When Hugo runs, it first looks for an overall configuration file, -in order to read its settings, and applies them to the entire website. -These settings override Hugo's default values. +When Hugo runs, it first looks for an overall configuration file, in order to read its settings, and applies them to the entire website. These settings override Hugo's default values. -The file can be in TOML, YAML, or JSON format. -I prefer TOML for my configuration files. -If you prefer JSON or YAML, you'll need to translate my examples. -You'll also need to change the basename, since Hugo uses its extension -to determine how to process it. +The file can be in TOML, YAML, or JSON format. I prefer TOML for my configuration files. If you prefer JSON or YAML, you'll need to translate my examples. You'll also need to change the basename, since Hugo uses its extension to determine how to process it. + +Hugo translates Markdown files into HTML. By default, Hugo searches for Markdown files in the `./content/` tree and template files under the `./themes/` directory. It will render HTML files to the `./public/` tree. You can override any of these defaults by specifying alternative locations in the configuration file. -Hugo translates Markdown files into HTML. -By default, Hugo searches for Markdown files in the `./content/` tree -and template files under the `./themes/` directory. -It will render HTML files to the `./public/` tree. -You can override any of these defaults by specifying alternative locations -in the configuration file. ### Template -_Templates_ direct Hugo in rendering content into HTML; -they bridge content and presentation. +_Templates_ direct Hugo in rendering content into HTML; they bridge content and presentation. -Rules in template files determine which content is published and where, -and precisely how it will be rendered into HTML files. -Templates also guide your website's presentation -by specifying the CSS styling to use. +Rules in template files determine which content is published and where, and precisely how it will be rendered into HTML files. Templates also guide your website's presentation by specifying the CSS styling to use. -Hugo uses its knowledge of each piece of content -to seek a template file to use in rendering it. -If it can't find a template that matches the content, it will zoom out, -one conceptual level; it will then resume the search from there. -It will continue to do so, till it finds a matching template, -or runs out of templates to try. -Its last resort is your website's default template, -which could conceivably be missing. If it finds no suitable template, -it simply forgoes rendering that piece of content. +Hugo uses its knowledge of each piece of content to seek a template file to use in rendering it. If it can't find a template that matches the content, it will zoom out, one conceptual level; it will then resume the search from there. It will continue to do so, till it finds a matching template, or runs out of templates to try. Its last resort is your website's default template, which could conceivably be missing. If it finds no suitable template, it simply forgoes rendering that piece of content. + +It's important to note that _front matter_ (see next) can influence Hugo's template file selection process. -It's important to note that _front-matter_ (see next) -can influence Hugo's template file selection process. ### Content -Content is stored in text files which contain two sections. -The first is called _front-matter_: this is information about the content. -The second contains Markdown-formatted text, -destined for conversion to HTML format. -#### Front-Matter +Content is stored in text files which contain two sections. The first is called _front matter_: this is information about the content. The second contains Markdown-formatted text, destined for conversion to HTML format. -The _front-matter_ is meta-information describing the content. -Like the website's configuration file, it can be written in the -TOML, YAML, or JSON formats. -Unlike the configuration file, Hugo doesn't use the file's extension -to determine the format. -Instead, it looks for markers in the file which signal this. -TOML is surrounded by "`+++`" and YAML by "`---`", but -JSON is enclosed in curly braces. I prefer to use TOML. -You'll need to translate my examples if you prefer YAML or JSON. +#### Front Matter + +The _front matter_ is meta-information describing the content. Like the website's configuration file, it can be written in the TOML, YAML, or JSON formats. + +Unlike the configuration file, Hugo doesn't use the file's extension to determine the format. + +Instead, it looks for markers in the file which signal this. TOML is surrounded by "`+++`" and YAML by "`---`", but JSON is enclosed in curly braces. I prefer to use TOML. You'll need to translate my examples if you prefer YAML or JSON. + +Hugo informs its chosen template files with the front matter information before rendering the content in HTML. -Hugo informs its chosen template files with the front-matter information -before rendering the content in HTML. #### Markdown -Content is written in Markdown format, which makes it easy to create. -Hugo runs the content through a Markdown engine to transform it into HTML, -which it then renders to the output file. -### Template Kinds +Content is written in Markdown format, which makes it easy to create. Hugo runs the content through a Markdown engine to transform it into HTML, which it then renders to the output file. + +### Templates + +Here I'll discuss three kinds of Hugo templates: _Single_, _List_, and _Partial_. All these kinds take one or more pieces of content as input and transform the pieces, based on commands in the template. -Here I'll discuss three kinds of Hugo templates: -_Single_, _List_, and _Partial_. -All these kinds take one or more pieces of content as input, -and transform the pieces, based on commands in the template. #### Single -A _Single_ template is used to render one piece of content. -For example, an article or a post is a single piece of content; -thus, it uses a Single template. +A _Single_ template is used to render one piece of content. For example, an article or a post is a single piece of content; thus, it uses a Single template. + #### List -A _List_ template renders a group of related content items. -This could be a summary of recent postings, -or all of the articles in a category. -List templates can contain multiple groups (or categories). +A _List_ template renders a group of related content items. This could be a summary of recent postings, or all of the articles in a category. List templates can contain multiple groups (or categories). + +The home page template is a special kind of List template. This is because Hugo assumes that your home page will act as a portal to all of the remaining content on your website. -The home page template is a special kind of List template. -This is because Hugo assumes that your home page will act as a portal -to all of the remaining content on your website. #### Partial -A _Partial_ template is a template that's incapable of producing a web page, -by itself. To include a Partial template in your website, -another template must call it, using the `partial` command. +A _Partial_ template is a template that's incapable of producing a web page, by itself. To include a Partial template in your website, another template must call it, using the `partial` command. + +Partial templates are very handy for rolling up common behavior. For example, you might want the same banner to appear on all of your website's pages — so, rather than copy your banner's text into multiple content files, as well as the other information relevant to your banner into multiple template files (both Single and List), you can instead create just one content file and one Partial template. That way, whenever you decide to change the banner, you can do so by editing one file only (or maybe two). -Partial templates are very handy for rolling up common behavior. -For example, you might want the same banner to appear on all -of your website's pages — so, rather than copy your banner's text -into multiple content files, -as well as the other information relevant to your banner -into multiple template files (both Single and List), -you can instead create just one content file and one Partial template. -That way, whenever you decide to change the banner, you can do so -by editing one file only (or maybe two). ## Site -Let's let Hugo help you create your new website. -The `hugo new site` command will generate a skeleton — -it will give you a basic directory structure, along with -a usable configuration file: +Let's let Hugo help you create your new website. The `hugo new site` command will generate a skeleton—it will give you a basic directory structure, along with a usable configuration file: + ```bash $ cd /tmp/ @@ -260,20 +184,15 @@ drwxr-xr-x 2 {user} {group} 68 {date} layouts drwxr-xr-x 2 {user} {group} 68 {date} static drwxr-xr-x 2 {user} {group} 68 {date} themes ``` -Take a look in the `./content/` and `./themes/` directories to confirm -they are empty. -The other directories -(`./archetypes/`, `./data/`, `./layouts/` and `./static/`) -are used for customizing a named theme. -That's a topic for a different tutorial, so please ignore them for now. +Take a look in the `./content/` and `./themes/` directories to confirm they are empty. + +The other directories (`./archetypes/`, `./data/`, `./layouts/` and `./static/`) are used for customizing a named theme. That's a topic for a different tutorial, so please ignore them for now. + ### Render -Running the `hugo` command with no options will read -all of the available content and render the HTML files. Also, it will copy -all the static files (that's everything besides content). -Since we have an empty website, Hugo won't be doing much. -However, generally speaking, Hugo does this very quickly: +Running the `hugo` command with no options will read all of the available content and render the HTML files. Also, it will copy all the static files (that's everything besides content). Since we have an empty website, Hugo won't be doing much. However, generally speaking, Hugo does this very quickly: + ```bash $ hugo --verbose INFO: {date} {source} Using config file: /tmp/mySite/config.toml @@ -300,13 +219,12 @@ WARN: {date} {source} "404.html" is rendered empty 0 categories created in 4 ms ``` + The "`--verbose`" flag gives extra information that will be helpful -whenever we are developing a template. -Every line of the output starting with "INFO:" or "WARN:" is present -because we used that flag. The lines that start with "WARN:" -are warning messages. We'll go over them later. +whenever we are developing a template. Every line of the output starting with "INFO:" or "WARN:" is present because we used that flag. The lines that start with "WARN:" are warning messages. We'll go over them later. We can verify that the command worked by looking at the directory again: + ```bash $ ls -l total 8 @@ -319,11 +237,9 @@ drwxr-xr-x 6 {user} {group} 204 {date} public drwxr-xr-x 2 {user} {group} 68 {date} static drwxr-xr-x 2 {user} {group} 68 {date} themes ``` -See that new `./public/` directory? -Hugo placed all its rendered content there. -When you're ready to publish your website, that's the place to start. -For now, though, let's just confirm we have the files we expect -for a website with no content: + +See that new `./public/` directory? Hugo placed all its rendered content there. When you're ready to publish your website, that's the place to start. For now, though, let's just confirm we have the files we expect for a website with no content: + ```bash $ ls -l public/ total 16 @@ -332,25 +248,23 @@ total 16 -rw-r--r-- 1 {user} {group} 511 {date} index.xml -rw-r--r-- 1 {user} {group} 210 {date} sitemap.xml ``` -Hugo rendered two XML files and some empty HTML files. -The XML files are used for RSS feeds. Hugo has an opinion about what -those feeds should contain, so it populated those files. -Hugo has no opinion on the look or content of your website, -so it left those files empty. -If you look back at the output from the `hugo server` command, -you'll notice that Hugo said: +Hugo rendered two XML files and some empty HTML files. The XML files are used for RSS feeds. Hugo has an opinion about what those feeds should contain, so it populated those files. Hugo has no opinion on the look or content of your website, so it left those files empty. + +If you look back at the output from the `hugo server` command, you'll notice that Hugo said: + ```bash 0 pages created ``` -That's because Hugo doesn't count the home page, the 404 error page, -or the RSS feed files as pages. + +That's because Hugo doesn't count the home page, the 404 error page, or the RSS feed files as pages. + ### Serve -Let's verify you can run the built-in web server — -that'll shorten your development cycle, dramatically. -Start it, by running the `hugo server` command. -If successful, you'll see output similar to the following: +Let's verify you can run the built-in web server — that'll shorten your development cycle, dramatically. + +Start it, by running the `hugo server` command. If successful, you'll see output similar to the following: + ```bash $ hugo server --verbose INFO: {date} {source} Using config file: /tmp/mySite/config.toml @@ -380,57 +294,40 @@ Serving pages from memory Web Server is available at http://localhost:1313/ (bind address 127.0.0.1) Press Ctrl+C to stop ``` + Connect to the listed URL (it's on the line that begins with `Web Server is available`). If everything's working correctly, you should get a page that shows nothing. + ### Warnings Let's go back and look at some of those warnings again: + ```bash WARN: {date} {source} Unable to locate layout for 404 page: [404.html] WARN: {date} {source} Unable to locate layout for homepage: [index.html _default/list.html] ``` -The 404 warning is easy to explain — it's because we haven't created -the template file `layouts/404.html`. Hugo uses this to render an HTML file -which serves "page not found" errors. However, -the 404 page is a topic for a separate tutorial. -Regarding the home page warning: the first layout Hugo looked for was -`layouts/index.html`. Note that Hugo uses this file for the home page only. +The 404 warning is easy to explain — it's because we haven't created the template file `layouts/404.html`. Hugo uses this to render an HTML file which serves "page not found" errors. However, the 404 page is a topic for a separate tutorial. -It's good that Hugo lists the files it seeks, when -we give it the verbose flag. For the home page, these files are -`layouts/index.html` and `layouts/_default/list.html`. -Later, we'll cover some rules which explain these paths -(including their basenames). For now, just remember that -Hugo couldn't find a template to use for the home page, and it said so. +Regarding the home page warning: the first layout Hugo looked for was `layouts/index.html`. Note that Hugo uses this file for the home page only. + +It's good that Hugo lists the files it seeks, when we give it the verbose flag. For the home page, these files are `layouts/index.html` and `layouts/_default/list.html`. Later, we'll cover some rules which explain these paths (including their basenames). For now, just remember that Hugo couldn't find a template to use for the home page, and it said so. + +All right! So, now — after these few steps — you have a working installation, and a website foundation you can build upon. All that's left is to add some content, as well as a theme to display it. -All right! So, now — after these few steps — you have a working -installation, and a website foundation you can build upon. -All that's left is to add some content, as well as a theme to display it. ## Theme -Hugo doesn't ship with a default theme. However, a large number of themes -are easily available: for example, at -[hugoThemes](https://github.com/spf13/hugoThemes). -Also, Hugo comes with a command to generate them. +Hugo doesn't ship with a default theme. However, a large number of themes are easily available: for example, at [hugoThemes](https://github.com/spf13/hugoThemes). Also, Hugo comes with a command to generate them. -We're going to generate a new theme called Zafta. -The goal of this tutorial is simply to show you how to create -(in a theme) the minimal files Hugo needs in order to display your content. -Therefore, the theme will exclude CSS — -it'll be functional, not beautiful. +We're going to generate a new theme called Zafta. The goal of this tutorial is simply to show you how to create (in a theme) the minimal files Hugo needs in order to display your content. Therefore, the theme will exclude CSS — it'll be functional, not beautiful. + +Every theme has its own opinions on content and layout. For example, this Zafta theme prefers the Type "article" over the Types "blog" or "post."Strong opinions make for simpler templates, but unconventional opinions make themes tougher for other users. So when you develop a theme, you should consider the value of adopting the terms used by themes similar to yours. -Every theme has its own opinions on content and layout. For example, this -Zafta theme prefers the Type "article" over the Types "blog" or "post." -Strong opinions make for simpler templates, but unconventional opinions -make themes tougher for other users. So when you develop a theme, you should -consider the value of adopting the terms used by themes similar to yours. ### Skeleton -Let's press Ctrl+C and use the `hugo new theme` command -to generate the skeleton of a theme. The result is a directory structure -containing empty files for you to fill out: +Let's press Ctrl+C and use the `hugo new theme` command to generate the skeleton of a theme. The result is a directory structure containing empty files for you to fill out: + ```bash $ hugo new theme zafta @@ -445,17 +342,13 @@ $ find themes -type f | xargs ls -l -rw-r--r-- 1 {user} {group} 1081 {date} themes/zafta/LICENSE.md -rw-r--r-- 1 {user} {group} 450 {date} themes/zafta/theme.toml ``` -The skeleton includes templates (files ending in `.html`), a license file, -a description of your theme (`theme.toml`), and a default archetype file. -When you're developing a real theme, please remember to fill out files -`theme.toml` and `LICENSE.md`. They're optional, but if you're going to -distribute your theme, it tells the world who to praise (or blame). -It's also important to declare your choice of license, so people will know -whether (or where) they can use your theme. +The skeleton includes templates (files ending in `.html`), a license file, a description of your theme (`theme.toml`), and a default archetype file. + +When you're developing a real theme, please remember to fill out files `theme.toml` and `LICENSE.md`. They're optional, but if you're going to distribute your theme, it tells the world who to praise (or blame). It's also important to declare your choice of license, so people will know whether (or where) they can use your theme. + +Note that the skeleton theme's template files are empty. Don't worry; we'll change that shortly: -Note that the skeleton theme's template files are empty. Don't worry; -we'll change that shortly: ```bash $ find themes/zafta -name '*.html' | xargs ls -l -rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/404.html @@ -465,6 +358,7 @@ $ find themes/zafta -name '*.html' | xargs ls -l -rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/partials/footer.html -rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/partials/header.html ``` + ### Select Now that we've created a theme we can work with, it's a good idea @@ -476,6 +370,7 @@ or specify it on the command line, sometimes you won't get the template you're expecting. So, let's edit your configuration file to add the theme name: + ```toml $ vi config.toml theme = "zafta" @@ -484,9 +379,11 @@ title = "My New Hugo Site" languageCode = "en-us" :wq ``` + ### Themed Render Now that we have a theme (albeit empty), let's render the website again: + ```bash $ hugo --verbose INFO: {date} {source} Using config file: /tmp/mySite/config.toml @@ -512,13 +409,13 @@ WARN: {date} {source} "404.html" is rendered empty 0 categories created in 4 ms ``` + Did you notice the output is different? -Two previous warning messages have disappeared, which contained the words -"Unable to locate layout" for your home page and the 404 page. -And, a new informational message tells us Hugo is accessing your theme's tree -(`./themes/zafta/`). + +Two previous warning messages have disappeared, which contained the words "Unable to locate layout" for your home page and the 404 page. And, a new informational message tells us Hugo is accessing your theme's tree (`./themes/zafta/`). Let's check the `./public/` directory to see what Hugo rendered: + ```bash $ ls -l public/ total 16 @@ -529,26 +426,21 @@ drwxr-xr-x 2 {user} {group} 68 {date} css drwxr-xr-x 2 {user} {group} 68 {date} js -rw-r--r-- 1 {user} {group} 210 {date} sitemap.xml ``` -It's similar to what we had before, without a theme. -We'd expect so, since all your theme's templates are empty. But notice: -in `./public/`, Hugo created the `css/` and `js/` directories. -That's because Hugo found them in your theme's `static/` directory: + +It's similar to what we had before, without a theme. We'd expect so, since all your theme's templates are empty. But notice: in `./public/`, Hugo created the `css/` and `js/` directories. That's because Hugo found them in your theme's `static/` directory: + ```bash $ ls -l themes/zafta/static/ total 0 drwxr-xr-x 2 {user} {group} 68 {date} css drwxr-xr-x 2 {user} {group} 68 {date} js ``` + #### Home -In a Hugo website, each kind of page is informed (primarily) by just one -of the many different kinds of templates available; -yet the home page is special, because it gets its own kind of template, -and its own template file. +In a Hugo website, each kind of page is informed (primarily) by just one of the many different kinds of templates available; yet the home page is special, because it gets its own kind of template, and its own template file. -Hugo uses template file `layouts/index.html` to render the home page's HTML. -Although Hugo's documentation may state that this file is the home page's -only required template, Hugo's earlier warning message showed it actually +Hugo uses template file `layouts/index.html` to render the home page's HTML. Although Hugo's documentation may state that this file is the home page's only required template, Hugo's earlier warning message showed it actually looks for two different templates: ```bash WARN: {date} {source} Unable to locate layout for homepage: [index.html _default/list.html] @@ -566,6 +458,7 @@ $ find * -name index.html | xargs ls -l -rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/index.html ``` As we'll see later, Hugo follows this same pattern for all its templates. + ## Static Files Hugo does two things when it renders your website. @@ -609,58 +502,36 @@ if you want to start with a clean slate.) 1. Glance at your browser window to see your changes; and 1. Repeat. -I'll throw in one more opinion: ***never*** directly edit a theme on a live -website. Instead, always develop ***using a copy***. First, make some changes -to your theme and test them. Afterwards, **when you've got them working,** -copy them to your website. For added safety, use a tool like Git to keep -some revision history of your content, and of your theme. Believe me: -it's too easy to lose your changes, and your mind! +I'll throw in one more opinion: ***never*** directly edit a theme on a live website. Instead, always develop ***using a copy***. First, make some changes to your theme and test them. Afterwards, **when you've got them working,** copy them to your website. For added safety, use a tool like Git to keep some revision history of your content, and of your theme. Believe me: it's too easy to lose your changes, and your mind! Check out the main Hugo website for information about using Git with Hugo. + ### Purge -When rendering your website, Hugo will create new files in the `./public/` -tree and update existing ones. But it won't delete files that are -no longer used. For example, files previously rendered with -(what is now) the wrong basename, or in the wrong directory, will remain. -Later, if you leave them, they'll likely confuse you. -Cleaning out your `./public/` files prior to rendering can help. +When rendering your website, Hugo will create new files in the `./public/` tree and update existing ones. But it won't delete files that are no longer used. For example, files previously rendered with (what is now) the wrong basename, or in the wrong directory, will remain. Later, if you leave them, they'll likely confuse you. Cleaning out your `./public/` files prior to rendering can help. + +When Hugo is running in web server mode (as of version 0.15), it doesn't actually write the files. Instead, it keeps all the rendered files in memory. So, you can "clean" up your files simply by stopping and restarting the web server. -When Hugo is running in web server mode (as of version 0.15), -it doesn't actually write the files. Instead, -it keeps all the rendered files in memory. So, you can "clean" up -your files simply by stopping and restarting the web server. ### Serve + #### Watch -Hugo's watch functionality monitors the relevant content, theme and -(overriding) site trees for filesystem changes, -and renders your website again automatically, when changes are detected. +Hugo's watch functionality monitors the relevant content, theme and (overriding) site trees for filesystem changes, and renders your website again automatically, when changes are detected. -By default, watch is -enabled when in web server mode (`hugo server`), -but disabled for the website renderer (`hugo`). +By default, watch is enabled when in web server mode (`hugo server`), but disabled for the website renderer (`hugo`). -In some use cases, -Hugo's website renderer should continue running and watch — simply -type `hugo --watch` on the command line. +In some use cases, Hugo's website renderer should continue running and watch — simply type `hugo --watch` on the command line. + +Sometimes with Docker containers (and Heroku slugs), the site sources may live on a read-only filesystem. In that scenario, it makes no sense for Hugo's web server to watch for file changes — so use `hugo server --watch=false`. -Sometimes with Docker containers (and Heroku slugs), -the site sources may live on a read-only filesystem. -In that scenario, it makes no sense -for Hugo's web server to watch for file changes — so -use `hugo server --watch=false`. #### Reload -Hugo's built in web server includes -[LiveReload](/extras/livereload/) functionality. When any page is updated -in the filesystem, the web browser is told to refresh its currently-open tabs -from your website. Usually, this happens faster than you can say, -"Wow, that's totally amazing!" +Hugo's built in web server includes [LiveReload](/extras/livereload/) functionality. When any page is updated in the filesystem, the web browser is told to refresh its currently-open tabs from your website. Usually, this happens faster than you can say, "Wow, that's totally amazing!" + ### Workflow -Again, -I recommend you use the following commands as the basis for your workflow: +Again, I recommend you use the following commands as the basis for your workflow: + ```bash # purge old files. Hugo will recreate the public directory $ rm -rf public/ @@ -670,11 +541,11 @@ $ rm -rf public/ $ hugo server --verbose Press Ctrl+C to stop ``` -Below is some sample output showing Hugo detecting a change in the home page -template. (Actually, the change is the edit we're about to do.) Once it's -rendered again, the web browser automatically reloads the page. -(As I said above — it's amazing:) +Below is some sample output showing Hugo detecting a change in the home page template. (Actually, the change is the edit we're about to do.) Once it's rendered again, the web browser automatically reloads the page. + +As I said above — it's amazing:) + ```bash $ rm -rf public/ @@ -723,22 +594,17 @@ in 3 ms ``` ## Home Template -The home page is one of the few special pages Hugo renders automatically. -As mentioned earlier, it looks in your theme's `layouts/` tree for one -of two files: +The home page is one of the few special pages Hugo renders automatically. As mentioned earlier, it looks in your theme's `layouts/` tree for one of two files: 1. `index.html` 1. `_default/list.html` -We could edit the default template, but a good design principle is to edit -the most specific template available. That's not a hard-and-fast rule -(in fact, in this tutorial, we'll break it a few times), -but it's a good generalization. +We could edit the default template, but a good design principle is to edit the most specific template available. That's not a hard-and-fast rule (in fact, in this tutorial, we'll break it a few times), but it's a good generalization. + ### Static -Right now, your home page is empty because you've added no content, -and because its template includes no logic. Let's change that by adding -some text to your home page template (`layouts/index.html`): +Right now, your home page is empty because you've added no content, and because its template includes no logic. Let's change that by adding some text to your home page template (`layouts/index.html`): + ```html $ vi themes/zafta/layouts/index.html @@ -749,7 +615,9 @@ $ vi themes/zafta/layouts/index.html :wq ``` + Let's press Ctrl+C and render the website, and then verify the results: + ```html $ rm -rf public/ @@ -782,23 +650,20 @@ $ cat public/index.html ``` + ### Dynamic -A ***dynamic*** home page? Because Hugo is a _static website_ generator, -the word _dynamic_ seems odd, doesn't it? But this means arranging for your -home page to reflect the content in your website automatically, -each time Hugo renders it. +A ***dynamic*** home page? Because Hugo is a _static website_ generator, the word _dynamic_ seems odd, doesn't it? But this means arranging for your home page to reflect the content in your website automatically, each time Hugo renders it. To accomplish that, later we'll add an iterator to your home page template. + ## Article -Now that Hugo is successfully rendering your home page with static content, -let's add more pages to your website. We'll display some new articles -as a list on your home page; and we'll display each article -on its own page, too. +Now that Hugo is successfully rendering your home page with static content, let's add more pages to your website. We'll display some new articles as a list on your home page; and we'll display each article on its own page, too. Hugo has a command to generate an entry skeleton for new content, just as it does for websites and themes: + ```bash $ hugo --verbose new article/First.md INFO: {date} {source} Using config file: /tmp/mySite/config.toml @@ -825,7 +690,7 @@ total 16 -rw-r--r-- 1 {user} {group} 61 {date} First.md -rw-r--r-- 1 {user} {group} 62 {date} Second.md ``` -Let's edit both those articles. Be careful to preserve their front-matter, +Let's edit both those articles. Be careful to preserve their front matter, but append some text to their bodies, as follows: ```bash $ vi content/article/First.md @@ -849,7 +714,9 @@ pulvinar. Ut mattis gravida venenatis. Vivamus lobortis risus id nisi rutrum, at iaculis. :wq ``` + So, for example, `./content/article/Second.md` becomes: + ```toml $ cat content/article/Second.md +++ @@ -867,6 +734,7 @@ pulvinar. Ut mattis gravida venenatis. Vivamus lobortis risus id nisi rutrum, at iaculis. ``` Let's render the website, and then verify the results: + ```bash $ rm -rf public/ @@ -892,8 +760,9 @@ WARN: {date} {source} "404.html" is rendered empty 0 categories created in 7 ms ``` -The output says Hugo rendered ("created") two pages. -Those pages are your new articles: + +The output says Hugo rendered ("created") two pages. Those pages are your new articles: + ```bash $ find public -type f -name '*.html' | xargs ls -l -rw-r--r-- 1 {user} {group} 0 {date} public/404.html @@ -902,8 +771,10 @@ $ find public -type f -name '*.html' | xargs ls -l -rw-r--r-- 1 {user} {group} 0 {date} public/article/Second/index.html -rw-r--r-- 1 {user} {group} 72 {date} public/index.html ``` + The new pages are empty, because Hugo rendered their HTML from empty template files. The home page doesn't show us the new content, either: + ```html $ cat public/index.html @@ -913,29 +784,22 @@ $ cat public/index.html ``` + So, we have to edit the templates, in order to pick up the articles. + ### Single & List -Here again I'll discuss three kinds of Hugo templates. One kind is -the home page template we edited previously; it's applicable only to -the home page. Another kind is Single templates, which render output for -just one content file. The third kind are List templates, which group -multiple pieces of content before rendering output. +Here again I'll discuss three kinds of Hugo templates. One kind is the home page template we edited previously; it's applicable only to the home page. Another kind is Single templates, which render output for just one content file. The third kind are List templates, which group multiple pieces of content before rendering output. -It's important to note that, generally, List templates -(except the home page template) are named `list.html`; -and Single templates are named `single.html`. +It's important to note that, generally, List templates (except the home page template) are named `list.html`; and Single templates are named `single.html`. -Hugo also has three other kinds of templates: -Partials, _Content Views_, and _Terms_. -We'll give examples of some Partial templates; but otherwise, +Hugo also has three other kinds of templates: Partials, _Content Views_, and _Terms_. We'll give examples of some Partial templates; but otherwise, we won't go into much detail about these. + ### Home -You'll want your home page to list the articles you just created. -So, let's alter its template file (`layouts/index.html`) to show them. -Hugo runs each template's logic whenever it renders that template's web page -(of course): +You'll want your home page to list the articles you just created. So, let's alter its template file (`layouts/index.html`) to show them. Hugo runs each template's logic whenever it renders that template's web page (of course): + ```html $ vi themes/zafta/layouts/index.html @@ -948,6 +812,7 @@ $ vi themes/zafta/layouts/index.html :wq ``` + #### Engine Hugo uses the [Go language's template @@ -962,45 +827,27 @@ immediately before a closing one, will prevent extraneous newlines. So, the mustache commands in your newly-altered template are: -1.  `range ...` -1.  `.Permalink` -1.  `.Title` -1.  `end` +1.`range ...` +2.`.Permalink` +3.`.Title` +4.`end` -The `range` command is an iterator. We're using it to go through the latest -ten pages. (Hugo characterizes some of its HTML output files as "pages," -but not all — see above.) +The `range` command is an iterator. We're using it to go through the latest ten pages. (Hugo characterizes some of its HTML output files as "pages," but not all — see above.) -Looping through the list of data pages will consider each such HTML file -that Hugo renders (or rather — to speak more precisely — each -such HTML file that Hugo currently calculates it _will_ render). +Looping through the list of data pages will consider each such HTML file that Hugo renders (or rather — to speak more precisely — each such HTML file that Hugo currently calculates it _will_ render). -It's helpful to remember that Hugo sets some variables, such as `.Data`, quite -early in its overall processing. Hugo loads information from every content -file into that variable, and gives all the templates a chance to process that -variable's contents, before actually rendering any HTML output files. +It's helpful to remember that Hugo sets some variables, such as `.Data`, quite early in its overall processing. Hugo loads information from every contentfile into that variable, and gives all the templates a chance to process that variable's contents, before actually rendering any HTML output files. -`.Permalink` supplies the URL which links to that article's page, and -`.Title` supplies the value of its "title" variable. Hugo obtains this -from the front-matter in the article's Markdown file. +`.Permalink` supplies the URL which links to that article's page, and `.Title` supplies the value of its "title" variable. Hugo obtains this from the front matter in the article's Markdown file. -Automatically, the pages are considered in descending order of the generation -times of their Markdown files (actually, based on the value of the "date" -variable in their front-matter) so that the latest is first (naturally). +Automatically, the pages are considered in descending order of the generation times of their Markdown files (actually, based on the value of the "date" variable in their front matter) so that the latest is first (naturally). -The `end` command signals the end of the range iterator. The engine -loops back to the top of the iterator, whenever it finds `end.` -Everything between `range` and `end` is reevaluated, -each time the engine goes through the iterator. +The `end` command signals the end of the range iterator. The engine loops back to the top of the iterator, whenever it finds `end.` Everything between `range` and `end` is reevaluated, each time the engine goes through the iterator. -For the present template, this means that the titles of your latest -ten pages (or however many exist, if that's less) become the -[textContent](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent) -of an equivalent number of copies Hugo makes, of your level-four -subheading tags (and anchor tags). `.Permalink` enables these to link -to the actual articles. +For the present template, this means that the titles of your latest ten pages (or however many exist, if that's less) become the [textContent](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent) of an equivalent number of copies Hugo makes, of your level-four subheading tags (and anchor tags). `.Permalink` enables these to link to the actual articles. Let's render your website, and then verify the results: + ```html $ rm -rf public/ @@ -1042,97 +889,62 @@ $ cat public/index.html ``` + ### All Done -Congratulations! Your home page shows the titles of your two articles, along -with the links to them. The articles themselves are still empty. But, -let's take a moment to appreciate what we've done, so far! +Congratulations! Your home page shows the titles of your two articles, along with the links to them. The articles themselves are still empty. But, let's take a moment to appreciate what we've done, so far! -Your home page template (`layouts/index.html`) now renders output dynamically. -Believe it or not, by inserting the range command inside those doubled -curly braces, you've learned everything you need to know — -essentially — about developing a theme. +Your home page template (`layouts/index.html`) now renders output dynamically. Believe it or not, by inserting the range command inside those doubled curly braces, you've learned everything you need to know — essentially — about developing a theme. + +All that's left is understanding which of your templates renders each content file, and becoming more familiar with the commands for the template engine. -All that's left is understanding which of your templates renders each content -file, and becoming more familiar with the commands for the template engine. ## More Well — if things were so simple, this tutorial would be much shorter! -Some things are still useful to learn, because they'll make creating new -templates _much_ easier — so, I'll cover them, now. +Some things are still useful to learn, because they'll make creating new templates _much_ easier — so, I'll cover them, now. + ### Base URL -While developing and testing your theme, did you notice that the links in the -rendered `./public/index.html` file use the full "baseURL" from your -`./config.toml` file? That's because those files are intended to be deployed -to your web server. +While developing and testing your theme, did you notice that the links in the rendered `./public/index.html` file use the full "baseURL" from your `./config.toml` file? That's because those files are intended to be deployed to your web server. -Whenever you test your theme, you start Hugo in web server mode -(with `hugo server`) and connect to it with your web browser. -That command is smart enough to replace the "baseURL" with -`http://localhost:1313` on the fly, so that the links automatically -work for you. +Whenever you test your theme, you start Hugo in web server mode (with `hugo server`) and connect to it with your web browser. That command is smart enough to replace the "baseURL" with `http://localhost:1313` on the fly, so that the links automatically work for you. That's another reason why we recommend testing with the built-in web server. + ### Content -The articles you've been working with are in your `./content/article/` -directory. That means their _Section_ (as far as templates are concerned) -is "article". Unless we do something unusual in their front-matter, their -_Type_ is also "article". +The articles you've been working with are in your `./content/article/` directory. That means their _Section_ (as far as templates are concerned) is "article". Unless we do something unusual in their front matter, their _Type_ is also "article". + #### Search -Hugo uses the Section and Type to find a template file for every piece of -content it renders. Hugo first will seek a template file in subdirectories of -`layouts/` that match its Section or Type name (i.e., in `layouts/SECTION/` -or `layouts/TYPE/`). If it can't find a file there, then it will look in the -`layouts/_default/` directory. Other documentation covers some twists about -categories and tags, but we won't use those in this tutorial. Therefore, -we can assume that Hugo will try first `layouts/article/single.html`, then -`layouts/_default/single.html`. +Hugo uses the Section and Type to find a template file for every piece of content it renders. Hugo first will seek a template file in subdirectories of `layouts/` that match its Section or Type name (i.e., in `layouts/SECTION/` or `layouts/TYPE/`). If it can't find a file there, then it will look in the `layouts/_default/` directory. Other documentation covers some twists about categories and tags, but we won't use those in this tutorial. Therefore, we can assume that Hugo will try first `layouts/article/single.html`, then `layouts/_default/single.html`. Now that we know the search rule, let's see what's available: + ```bash $ find themes/zafta -name single.html | xargs ls -l -rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/_default/single.html ``` -If you look back at the articles Hugo has rendered, you can see that -they were empty. Now we can see that this is because Hugo sought -`layouts/article/single.html` but couldn't find it, and template -`layouts/_default/single.html` was empty. Therefore, the rendered article -file was empty, too. -So, we could either create a new template, `layouts/article/single.html`, -or edit the default one. +If you look back at the articles Hugo has rendered, you can see that they were empty. Now we can see that this is because Hugo sought `layouts/article/single.html` but couldn't find it, and template `layouts/_default/single.html` was empty. Therefore, the rendered article file was empty, too. + +So, we could either create a new template, `layouts/article/single.html`, or edit the default one. + #### Default Single -Since we know of no other content Types, let's start by editing the default -template file, `layouts/_default/single.html`. +Since we know of no other content Types, let's start by editing the default template file, `layouts/_default/single.html`. -As we mentioned earlier, you always should edit (or create) the most -specific template first, in order to avoid accidentally changing how other -content is displayed. However, we're breaking that rule intentionally, -just so we can explore how the default is used. +As we mentioned earlier, you always should edit (or create) the most specific template first, in order to avoid accidentally changing how other content is displayed. However, we're breaking that rule intentionally, just so we can explore how the default is used. -Remember, any content — for which we don't create a specific template -— will end up using this default template. That can be good or bad. -Bad, because I know we'll be adding different Types of content, and we'll -eventually undo some of the changes we've made. Good, because then we'll be -able to see some results immediately. It's also good to create the default -template first, because with it, we can start to develop the basic layout -for the website. +Remember, any content — for which we don't create a specific template — will end up using this default template. That can be good or bad. Bad, because I know we'll be adding different Types of content, and we'll eventually undo some of the changes we've made. Good, because then we'll be able to see some results immediately. It's also good to create the default template first, because with it, we can start to develop the basic layout for the website. -As we add more content Types, we'll refactor this file and move its logic -around. Hugo makes this fairly painless, so we'll accept the cost and proceed. +As we add more content Types, we'll refactor this file and move its logic around. Hugo makes this fairly painless, so we'll accept the cost and proceed. -Please see Hugo's documentation on template rendering, for all the details on -determining which template to use. And, as the documentation mentions, if -your website is a single-page application (SPA), you can delete all the -other templates and work with just the default Single one. By itself, -that fact provides a refreshing amount of joy. +Please see Hugo's documentation on template rendering, for all the details on determining which template to use. And, as the documentation mentions, if your website is a single-page application (SPA), you can delete all the other templates and work with just the default Single one. By itself, that fact provides a refreshing amount of joy. Let's edit the default template file (`layouts/_default/single.html`): + ```html $ vi themes/zafta/layouts/_default/single.html @@ -1149,9 +961,11 @@ $ vi themes/zafta/layouts/_default/single.html :wq ``` + #### Verify Let's render the website, and verify the results: + ```bash $ rm -rf public/ @@ -1182,10 +996,12 @@ $ find public -type f -name '*.html' | xargs ls -l -rw-r--r-- 1 {user} {group} 514 {date} public/article/Second/index.html -rw-r--r-- 1 {user} {group} 232 {date} public/index.html ``` + Note that although Hugo rendered a file, to list your articles: `./public/article/index.html`, the file is empty, because we don't have a template for it. (However: see next.) The other HTML files contain your content, as we can see below: + ```html $ cat public/article/First/index.html @@ -1230,39 +1046,33 @@ lobortis risus id nisi rutrum, at iaculis.

    ``` -Again, notice that your rendered article files have content. -You can run `hugo server` and use your browser to confirm this. -You should see your home page, and it should contain the titles of both -articles. Each title should be a link to its respective article. -Each article should be displayed fully on its own page. And at the bottom of -each article, you should see a link which takes you back to your home page. +Again, notice that your rendered article files have content. You can run `hugo server` and use your browser to confirm this. You should see your home page, and it should contain the titles of both articles. Each title should be a link to its respective article. + +Each article should be displayed fully on its own page. And at the bottom of each article, you should see a link which takes you back to your home page. + ### Article List -Your home page still lists your most recent articles. However — -remember, from above, that I mentioned an empty file, +Your home page still lists your most recent articles. However — remember, from above, that I mentioned an empty file, `./public/article/index.html`? -Let's make that show a list of ***all*** of your articles -(not just the latest ten). -We need to decide which template to edit. Key to this, is that -individual pages always come from Single templates. On the other hand, -only List templates are capable of rendering pages which display collections -(or lists) of other pages. +Let's make that show a list of *all* of your articles rather than just the most recent ten. + +We need to decide which template to edit. Key to this, is that individual pages always come from Single templates. On the other hand, only List templates are capable of rendering pages which display collections (or lists) of other pages. + +Because the new page will show a listing, we should select a List template. Let's take a quick look to see which List templates are available already: -Because the new page will show a listing, we should select a List template. -Let's take a quick look to see which List templates are available already: ```bash $ find themes/zafta -name list.html | xargs ls -l -rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/_default/list.html ``` -So, just as before with the single articles, so again now with the list of -articles, we must decide: whether to edit `layouts/_default/list.html`, -or to create `layouts/article/list.html`. + +So, just as before with the single articles, so again now with the list of articles, we must decide: whether to edit `layouts/_default/list.html`, or to create `layouts/article/list.html`. + #### Default List -We still don't have multiple content Types — so, remaining consistent, -let's edit the default List template: +We still don't have multiple content Types — so, remaining consistent, let's edit the default List template: + ```html $ vi themes/zafta/layouts/_default/list.html @@ -1277,7 +1087,9 @@ $ vi themes/zafta/layouts/_default/list.html :wq ``` + Let's render everything again: + ```bash $ rm -rf public/ @@ -1307,18 +1119,17 @@ $ find public -type f -name '*.html' | xargs ls -l -rw-r--r-- 1 {user} {group} 514 {date} public/article/Second/index.html -rw-r--r-- 1 {user} {group} 232 {date} public/index.html ``` -Now (as you can see), we have a list of articles. To confirm it, -type `hugo server`; then, in your browser, navigate to `/article/`. -(Later, we'll link to it.) + +Now (as you can see), we have a list of articles. To confirm it, type `hugo server`; then, in your browser, navigate to `/article/`. (Later, we'll link to it.) + ## About -Let's add an About page, and try to display it at the top level -(as opposed to the next level down, where we placed your articles). +Let's add an About page, and try to display it at the top level (as opposed to the next level down, where we placed your articles). + ### Guide -Hugo's default goal is to let the directory structure of the `./content/` -tree guide the location of the HTML it renders to the `./public/` tree. -Let's check this, by generating an About page at the content's top level: +Hugo's default goal is to let the directory structure of the `./content/` tree guide the location of the HTML it renders to the `./public/` tree. Let's check this, by generating an About page at the content's top level: + ```toml $ hugo new About.md /tmp/mySite/content/About.md created @@ -1339,9 +1150,11 @@ ipsum quia dolor sit amet consectetur adipisci velit. :wq ``` + ### Check Let's render your website, and check the results: + ```html $ rm -rf public/ @@ -1396,13 +1209,13 @@ adipisci velit.

    ``` -Oh, well. — Did you notice that your page wasn't rendered at the -top level? It was rendered to a subdirectory named `./public/About/`. -That name came from the basename of your Markdown file `./content/About.md`. -Interesting — but, we'll let that go, for now. + +Oh, well. — Did you notice that your page wasn't rendered at the top level? It was rendered to a subdirectory named `./public/About/`. That name came from the basename of your Markdown file `./content/About.md`.Interesting — but, we'll let that go, for now. + ### Home One other thing — let's take a look at your home page: + ```html $ cat public/index.html @@ -1414,9 +1227,11 @@ $ cat public/index.html ``` + Did you notice that the About link is listed with your articles? That's not exactly where we want it; so, let's edit your home page template (`layouts/index.html`): + ```html $ vi themes/zafta/layouts/index.html @@ -1438,7 +1253,9 @@ $ vi themes/zafta/layouts/index.html :wq ``` + Let's render your website, and verify the results: + ```html $ rm -rf public/ @@ -1473,26 +1290,19 @@ $ cat public/index.html ``` -Good! This time, your home page has two Sections: "article" and "page", and -each Section contains the correct set of headings and links. + +Good! This time, your home page has two Sections: "article" and "page", and each Section contains the correct set of headings and links. + ## Template Sharing -If you've been following along on your computer, you might've noticed that -your home page doesn't show its title in your browser, although both of your -article pages do. That's because we didn't add your home page's title to its -template (`layouts/index.html`). That would be easy to do — but instead, -let's look at a better option. +If you've been following along on your computer, you might've noticed that your home page doesn't show its title in your browser, although both of your article pages do. That's because we didn't add your home page's title to its template (`layouts/index.html`). That would be easy to do — but instead, let's look at a better option. + +We can put the common information into a shared template. These reside in the `layouts/partials/` directory. -We can put the common information into a shared template. -These reside in the `layouts/partials/` directory. ### Header & Footer -In Hugo (as elsewhere), a Partial is a template that's intended to be used -within other templates. We're going to create a Partial template that will -contain a header, for all of your page templates to use. That Partial will -enable us to maintain the header information in a single place, thus easing -our maintenance. Let's create both the header (`layouts/partials/header.html`) -and the footer (`layouts/partials/footer.html`): +In Hugo (as elsewhere), a Partial is a template that's intended to be used within other templates. We're going to create a Partial template that will contain a header, for all of your page templates to use. That Partial will enable us to maintain the header information in a single place, thus easing our maintenance. Let's create both the header (`layouts/partials/header.html`) and the footer (`layouts/partials/footer.html`): + ```html $ vi themes/zafta/layouts/partials/header.html @@ -1509,18 +1319,19 @@ $ vi themes/zafta/layouts/partials/footer.html :wq ``` + ### Calling -Any `partial` is called relative to its conventional location -`layouts/partials/`. So, you pass just the basename, followed by the context -(the period before the closing mustache). For example: +Any `partial` is called relative to its conventional location `layouts/partials/`. So, you pass just the basename, followed by the context (the period before the closing mustache). For example: + ```bash {{ partial "header.html" . }} ``` + #### From Home -Let's change your home page template (`layouts/index.html`) -in order to use the new header Partial we just created: +Let's change your home page template (`layouts/index.html`) in order to use the new header Partial we just created: + ```html $ vi themes/zafta/layouts/index.html {{ partial "header.html" . }} @@ -1540,13 +1351,14 @@ $ vi themes/zafta/layouts/index.html :wq ``` -Render your website and verify the results. Now, the title on your home page -should be "My New Hugo Site". This comes from the "title" variable -in the `./config.toml` file. + +Render your website and verify the results. Now, the title on your home page should be "My New Hugo Site". This comes from the "title" variable in the `./config.toml` file. + #### From Default Let's also edit the default templates (`layouts/_default/single.html` and `layouts/_default/list.html`) to use your new Partials: + ```html $ vi themes/zafta/layouts/_default/single.html {{ partial "header.html" . }} @@ -1565,56 +1377,39 @@ $ vi themes/zafta/layouts/_default/list.html {{ partial "footer.html" . -}} :wq ``` -Render your website and verify the results. -Now, the title of your About page should reflect the value of the "title" -variable in its corresponding Markdown file (`./content/About.md`). -The same should be true for each of your article pages as well (i.e., -`./content/article/First.md` and `./content/article/Second.md`). + +Render your website and verify the results. Now, the title of your About page should reflect the value of the "title" variable in its corresponding Markdown file (`./content/About.md`). The same should be true for each of your article pages as well (i.e., `./content/article/First.md` and `./content/article/Second.md`). + ### DRY -Don't Repeat Yourself (also known as DRY) is a desirable goal, -in any kind of source code development — -and Hugo's partials do a fine job to help with that. +Don't Repeat Yourself (also known as DRY) is a desirable goal, in any kind of source code development — and Hugo's partials do a fine job to help with that. + +Part of the art of good templates is knowing when to add new ones, and when to edit existing ones. While you're still figuring out the art of templates, you should accept that you'll do some refactoring — Hugo makes this easy and fast. And it's okay to delay splitting your templates into Partials. -Part of the art of good templates is knowing when to add new ones, and when -to edit existing ones. While you're still figuring out the art of templates, -you should accept that you'll do some refactoring — Hugo makes this -easy and fast. And it's okay to delay splitting your templates into Partials. ## Section + ### Date -Articles commonly display the date they were published -(or finalized) — so, here, let's do the same. +Articles commonly display the date they were published (or finalized) — so, here, let's do the same. -The front-matter of your articles contains a "date" variable -(as discussed above). Hugo sets this, when it creates each content file. -Now, sometimes an article requires many days to prepare, so its actual -publishing date might be later than the front-matter's "date". However, for -simplicity's sake, let's pretend this is the date we want to display, each time. +The front matter of your articles contains a "date" variable (as discussed above). Hugo sets this, when it creates each content file. Now, sometimes an article requires many days to prepare, so its actual publishing date might be later than the front matter's "date". However, for simplicity's sake, let's pretend this is the date we want to display, each time. + +In Hugo, in order to format a variable date (or time), we must do it by formatting the Go language [reference time](https://golang.org/pkg/time/); for example: -In Hugo, in order to format a variable date (or time), -we must do it by formatting the Go language [reference -time](https://golang.org/pkg/time/); for example: ```bash {{ .Date.Format "Mon, Jan 2, 2006" }} ``` -Now, your articles use the `layouts/_default/single.html` template (see above). -Because that template includes a date-formatting snippet, they show a -nice looking date. However, your About page uses the same default template. -Unfortunately, now it too shows its creation date (which makes no sense)! -There are a couple of ways to make the date display only for articles. -We could use an "if" statement, to display the date only when the Type equals -"article." That is workable, and acceptable for websites with only a couple -of content Types. It aligns with the principle of "code for today," too. +Now, your articles use the `layouts/_default/single.html` template (see above). Because that template includes a date-formatting snippet, they show a nice looking date. However, your About page uses the same default template. Unfortunately, now it too shows its creation date (which makes no sense)! + +There are a couple of ways to make the date display only for articles. We could use an "if" statement, to display the date only when the Type equals "article." That is workable, and acceptable for websites with only a coupleof content Types. It aligns with the principle of "code for today," too. + ### Template -Let's assume, though (for didactic purposes), that you've made your website so -complex that you feel you must create a new template Type. In Hugo-speak, this -will be a new Section. It will contain your new, "article" Single template. +Let's assume, though (for didactic purposes), that you've made your website so complex that you feel you must create a new template Type. In Hugo-speak, this will be a new Section. It will contain your new, "article" Single template. + +Let's restore your default Single template (`layouts/_default/single.html`) to its earlier state (before we forget): -Let's restore your default Single template (`layouts/_default/single.html`) -to its earlier state (before we forget): ```html $ vi themes/zafta/layouts/_default/single.html {{ partial "header.html" . }} @@ -1623,10 +1418,9 @@ $ vi themes/zafta/layouts/_default/single.html {{ partial "footer.html" . -}} :wq ``` -Now, let's create your new template. If you remember Hugo's rules, -the template engine will prefer this version over the default. The first step -is to create (within your theme) its Section's directory: `layouts/article/`. -Then, create a Single template (`layouts/article/single.html`) within it: + +Now, let's create your new template. If you remember Hugo's rules, the template engine will prefer this version over the default. The first step is to create (within your theme) its Section's directory: `layouts/article/`. Then, create a Single template (`layouts/article/single.html`) within it: + ```html $ mkdir themes/zafta/layouts/article @@ -1638,8 +1432,8 @@ $ vi themes/zafta/layouts/article/single.html {{ partial "footer.html" . -}} :wq ``` -Basically, we moved the date logic — from the default template, to the -new "article" Section, Single template: `layouts/article/single.html`. + +Basically, we moved the date logic — from the default template, to the new "article" Section, Single template: `layouts/article/single.html`. Let's render your website and verify the results: @@ -1705,5 +1499,6 @@ adipisci velit.

    ``` -Now, as you can see, your articles show their dates, -and your About page (sensibly) doesn't. \ No newline at end of file +Now, as you can see, your articles show their dates, whereas your About page (sensibly) doesn't. + +[gitwindows]: https://git-for-windows.github.io/ \ No newline at end of file diff --git a/content/tutorials/migrate-from-jekyll-to-hugo.md b/content/tutorials/migrate-from-jekyll-to-hugo.md index e8c077c4f..ae9cccf5b 100644 --- a/content/tutorials/migrate-from-jekyll-to-hugo.md +++ b/content/tutorials/migrate-from-jekyll-to-hugo.md @@ -10,6 +10,7 @@ tags: [migrations,jekyll, command line] authors: [Alexandre Normand] weight: draft: false +hugoversion: 14 toc: true aliases: [/tutorials/migrate-from-jekyll/] needsreview: true diff --git a/content/variables-and-params/shortcode-git-and-hugo-variables.md b/content/variables-and-params/other-variables.md similarity index 97% rename from content/variables-and-params/shortcode-git-and-hugo-variables.md rename to content/variables-and-params/other-variables.md index 097d94b7c..7a9014402 100644 --- a/content/variables-and-params/shortcode-git-and-hugo-variables.md +++ b/content/variables-and-params/other-variables.md @@ -12,7 +12,6 @@ weight: 50 aliases: [/extras/gitinfo/,/variables-and-params/other/] toc: true needsreview: true -notesforauthors: --- ## Shortcode Variables @@ -88,31 +87,31 @@ We highly recommend using `.Hugo.Generator` in your website. It is already inclu A menu entry in a [menu template][] has the following properties: -`URL` +`.URL` : string -`Name` +`.Name` : string -`Menu` +`.Menu` : string -`Identifier` +`.Identifier` : string -`Pre` +`.Pre` : template.HTML -`Post` +`.Post` : template.HTML -`Weight` +`.Weight` : int -`Parent` +`.Parent` : string -`Children` +`.Children` : Menu diff --git a/content/variables-and-params/page-variables.md b/content/variables-and-params/page-variables.md index 778fe5b6a..910b0d348 100644 --- a/content/variables-and-params/page-variables.md +++ b/content/variables-and-params/page-variables.md @@ -43,7 +43,7 @@ See [`.Scratch`](/functions/scratch/) for page-scoped writable variables. : the approximate number of words in the content. `.Hugo` -: see [Hugo Variables](/variables-and-params/shortcode-git-and-hugo-variables/). +: see [Hugo Variables](/variables-and-params/other/). `.IsHome` : `true` in the context of the [home page](/templates/homepage-template/). diff --git a/layouts/shortcodes/input.html b/layouts/shortcodes/input.html index a920f2462..89870849e 100644 --- a/layouts/shortcodes/input.html +++ b/layouts/shortcodes/input.html @@ -1,3 +1,13 @@ +{{- if .IsNamedParams -}} +{{$filenameclass := index (split (.Get "filename") ".") 1 }} +
    + {{- with .Get "filename" -}}
    {{- . -}}
    {{- end -}} + + {{- .Inner -}} +
    +{{- else -}} {{$filenameclass := index (split (.Get 0) ".") 1 }}
    {{if ne $filenameclass "sh"}}{{.Get 0}}{{end}}
    {{- if ne (index .Params 1) "nocopy" -}} @@ -6,4 +16,5 @@ {{- end -}} {{- .Inner -}} -
    \ No newline at end of file +
    +{{end}} \ No newline at end of file diff --git a/layouts/shortcodes/lookupexplanation.html b/layouts/shortcodes/lookupexplanation.html index 7391999e3..1b8cae63f 100644 --- a/layouts/shortcodes/lookupexplanation.html +++ b/layouts/shortcodes/lookupexplanation.html @@ -1 +1 @@ -{{partial "lookup-explanation.html" . | markdownify}} \ No newline at end of file +{{partial "lookup-explanation-markdown.html" . | markdownify}} \ No newline at end of file diff --git a/themes/hugodocs/layouts/_default/single.html b/themes/hugodocs/layouts/_default/single.html index 394400623..616456d88 100644 --- a/themes/hugodocs/layouts/_default/single.html +++ b/themes/hugodocs/layouts/_default/single.html @@ -4,7 +4,7 @@
    {{partial "breadcrumb.html" . }} -

    {{with .LinkTitle}}{{.}}{{else}}{{ .Title | markdownify }}{{end}}

    +

    {{ .Title | markdownify }}

    {{partial "content-header-links.html" . }} {{partial "tags.html" . }} {{if .Params.needsreview }} diff --git a/themes/hugodocs/layouts/partials/lookup-explanation.html b/themes/hugodocs/layouts/partials/lookup-explanation-markdown.html similarity index 75% rename from themes/hugodocs/layouts/partials/lookup-explanation.html rename to themes/hugodocs/layouts/partials/lookup-explanation-markdown.html index 73df94daa..69019ccf8 100644 --- a/themes/hugodocs/layouts/partials/lookup-explanation.html +++ b/themes/hugodocs/layouts/partials/lookup-explanation-markdown.html @@ -1,4 +1,4 @@ -Hugo uses a prioritized list called the *lookup order* as it traverses your files looking for the appropriate template to render your content. The template lookup order is an inverted cascade: if template A isn’t present or specified, Hugo will look to template B. If template B isn't present or specified, Hugo will look for template C, and so on until it reaches the `layouts/_default/`` directory for your project, or in the case of themes, `themes//layouts/_default/`. In many ways, the lookup order is similar to the [control mechanism of a switch statement (without fallthrough)][switch] seen in many programming languages. +Hugo uses a prioritized list called the *lookup order* as it traverses your files looking for the appropriate template to render your content. The template lookup order is an inverted cascade: if template A isn’t present or specified, Hugo will look to template B. If template B isn't present or specified, Hugo will look for template C, and so on until it reaches the `layouts/_default/` directory for your project, or in the case of themes, `themes//layouts/_default/`. In many ways, the lookup order is similar to the [control mechanism of a switch statement (i.e. without fallthrough)][switch] seen in many programming languages. The power of the lookup order is that it enables you to craft specific layouts as needed without creating more templating than necessary, thereby keeping your templating [DRY][dry]. *Most sites will only need the default template files at the end of the lookup* (i.e. `_default/*.html`).