diff --git a/config.toml b/config.toml index 9bdc5c3cc..1cd22d938 100644 --- a/config.toml +++ b/config.toml @@ -33,7 +33,7 @@ logFile = "" metaDataFormat = "yaml" # This intelligently adds an "s" to the titles of list pages pluralizelisttitles = false -preserveTaxonomyNames = true +preserveTaxonomyNames = false # This sets the title of the directory where hugo builds and pushes the final site when running "Hugo" (ie, without "server") publishdir = "public" pygmentsUseClasses = true diff --git a/content/concept.md b/content/concept.md index c7e144f83..4bda8a534 100644 --- a/content/concept.md +++ b/content/concept.md @@ -13,55 +13,59 @@ aliases: [] toc: true --- -## Introduction +## Background -The claims made in this strategic document are largely *empirical* and pulled from two major sources: +The claims made in this document are largely *empirical* and pulled from two major sources: * My experience starting 18 months ago as a new Hugo user. * Conversations with fellow Hugo users and noted trends within the [Discussion Forum][forum]. -{{% note "What the hell is all of this, Ryan?" %}} -At the bottom of this document is a section that starts with [most important questions for the Hugo team](#ideal-workflow) and continues with a very high-level description of an *ideal* content strategy process. This has only been included to provide insight for those unfamiliar with fundamental content strategy concepts. +I am submitting these changes because I have been given [explicit permission to do so](https://discuss.gohugo.io/t/roadmap-to-hugo-v1-0/2278/34). Project kickoff was in November 2016 as a result of [this forum thread on a proposed source re-organization](https://discuss.gohugo.io/t/proposed-source-organization-for-hugo-docs-concept/4506). See also [this Discuss thread from @bep re: a new restructure and redesign](https://discuss.gohugo.io/t/documentation-restructure-and-design/1891/10). + +{{% note "What is this document, Ryan?" %}} +At the bottom of this document is a section that starts with the [most important questions for the Hugo team](#ideal-workflow) and continues with a very high-level description of an *ideal* content strategy process. This has only been included to provide insight for those unfamiliar with basic content strategy.. {{% /note %}} {{% warning "Disclaimer" %}} -WIP. Before any of my fellow content strategists banish me to content strategy hell, know that I *know* this is a *schlocky* version of a true strategic document. It'll get better. I promise. +WIP. Before any colleagues banish me to content strategy hell, know that I *know* this is a *schlocky* version of a true strategic document. It'll get better. I promise. {{% /warning %}} ## Strategy, Tactics, and Requirements ### Assumptions -First and foremost, the biggest shortcomings of the current documentation are a matter of *content* more than visual or UX design. +The biggest shortcomings of the current documentation are more a matter of *content* than visual design. -In addition, this project was started with the assumptions that the Hugo documentation +Additionally, current Hugo documentation * is confusing for new users * is a common complaint in the Hugo forums ([forum discussion 1][ex1], [forum discussion 2][ex2]) * lacks structure and is therefore - * unscalable, as demonstrated by patch pages (e.g. [here][patch1] and [here][patch2]) that seem out of place, require unnecessary drill-down, or duplicate content in other areas of the docs, thus requiring duplicative efforts to update + * unscalable, as demonstrated by patch pages (e.g. [here][patch1] and [here][patch2]) that seem out of place, require unnecessary drill-down, or duplicate content in other areas of the docs, thus requiring duplicative efforts to keep updated * inconsistent in its terminology, style, and (sometimes) layout - * limited in effective use of Alogolia's document search (i.e., due to redundant content grouping, headings, etc) + * limited in effective use of Algolia's document search (i.e., due to redundant content grouping, headings, etc) * difficult to optimize for external search engines (SEO) * does not leverage Hugo's more powerful features (e.g., only *one* archetype); leveraging these features would help address the aforementioned shortcomings (i.e., scalability, consistency, and search) * assumes a higher level of Golang proficiency than is realistic for newcomers to static site generators or general web development; a prime example is the sparsity of basic and advanced code samples for templating functions, some of which may still be wholly undocumented * lacks well-defined contribution and editorial guidelines for those interested in submitting or editing documentation +* is not up to date +* often unusable on smart phones or other mobile devices * needs reworking of its URL structure to represent a more intuitive mental model for end users ([Discuss][ds1]) ### Goals New Hugo documentation should... -* reduce confusion surrounding Hugo concepts; e.g., `list`, `section`, `page`, `kind`, and `content type` with the intention of +* reduce confusion surrounding core Hugo concepts; e.g., `list`, `section`, `page`, `kind`, and `content type` with the intention of * making it easier for new users to get up and running * creating better consistency and scalability for Hugo-dependent projects (viz., [themes.gohugo.io][hugothemes]) * reducing the frequency of beginner-level questions in the [Hugo Discussion Forum][forum] * not require, or assume, any degree of Golang proficiency from end users; - * that said, Hugo can—and *should*—act as a bridge for users interested in learning Golang. An implementationn example of this strategic point is the inclusion of `godocref:` as a default front matter field for all function and template pages. See [`archetypes/functions.md`][functionarchetype]. + * that said, Hugo can—and *should*—act as a bridge for users interested in learning Golang. An implemented example of this strategic point is the inclusion of `godocref:` as a default front matter field for all function and template pages. See [`archetypes/functions.md`][functionarchetype]. * be easiest to expand and edit for *contributors** but even easier to understand by *end users* * if you don't make it *very easy* for authors to contribute to documentation correctly, they will inevitably contribute *incorrectly*; * content modeling is king - * go DRY (e.g., by leveraging shortcodes whenever possible) + * go DRY (e.g., via shortcodes) * set required metadata (e.g., via section-specific *archetypes*) * develop contribution guidelines for both development *and* documentation * be equally accessible via mobile, tablet, desktop, and offline. @@ -98,7 +102,7 @@ The themes end user has * limited proficiency in the command line/prompt * proficiency in one of the [supported content formats](https://hugodocsconcept.netlify.com/content-management/formats/)(specifically markdown) -* access to static hosting; +* access to static hosting * limited proficiency in deploying a static website ### Requirements @@ -118,7 +122,7 @@ The following are high-level requirements for the documentation site. - [X] [Open Graph Protocol](http://ogp.me/) - [X] [schema.org](http://schema.org) -- [ ] [JSON+LD](https://developers.google.com/schemas/formats/json-ld), [validated](https://search.google.com/structured-data/testing-tool) +- [X] [JSON+LD](https://developers.google.com/schemas/formats/json-ld), [validated](https://search.google.com/structured-data/testing-tool) - [X] Consistent heading structure - [X] Semantic HTML5 elements (e.g., `article`, `main`, `aside`, `dl`) - [X] SSL @@ -127,19 +131,19 @@ The following are high-level requirements for the documentation site. #### Accessibility -- [ ] Aria roles -- [ ] Alt text for all images +- [X] Aria roles +- [X] Alt text for all images +- [X] `title` attribute for links #### Editorial and Content -- [ ] Basic style guide +- [X] Basic style guide - The style guide should facilitate a more consistent UX for the site but not be so complex as to deter documentation contributors - [X] Contribution guidelines (see [WIP on live site](https://hugodocsconcept.netlify.com/contribute/documentation/)) - [X] Standardized content types (see [WIP archetypes in source](https://github.com/rdwatters/hugo-docs-concept/tree/master/themes/hugodocs/archetypes) - [X] New content model, including taxonomies ([see tags page][tagspage]) -- [ ] DRY. New shortcodes for repeat content (e.g., lists of aliases, page variables, site variables, and others) +- [X] DRY. New shortcodes for repeat content (e.g., lists of aliases, page variables, site variables, and others) - [X] New site architecture and content groupings -- [ ] Single sample website (include in docs source, [`/static/example`](https://github.com/rdwatters/hugo-docs-concept/tree/master/static/example)) for consistent code samples or in-page tutorials #### Content Strategy Statement @@ -155,7 +159,7 @@ The following are high-level requirements for the documentation site. ## UX/UI -- [X] Copyable code blocks (via highlight.js, extended for hugo-specific keywords) +- [X] Copyable and/or downloadable code blocks (via highlight.js and clipboard.js, extended for hugo-specific keywords); see [this specific request from @bep for this feature](https://discuss.gohugo.io/t/proposed-source-organization-for-hugo-docs-concept/4506/10?u=rdwatters) - [X] Dual in-page navigation (i.e. site nav *and* in-page TOC) - [X] Smooth scrolling - [X] [RTD-style admonitions][admonitions] (see [example admonition shortcode](https://github.com/rdwatters/hugo-docs-concept/blob/master/layouts/shortcodes/note.html) and [examples on published site](/contribute/documentation/#admonition-short-codes)) @@ -171,6 +175,7 @@ The following are high-level requirements for the documentation site. - [X] Google Analytics - [ ] Content groupings (GA) to measure usage, behavior flow, and define content gaps - [ ] Automated reports (GA) + - [ ] Potential for using Google Sheets CSV for published content on the docs {{% note %}} The preceding analytics and metrics are separate from usage statics re: Hugo downloads, `.Hugo.Generator`, etc. @@ -184,7 +189,7 @@ The preceding analytics and metrics are separate from usage statics re: Hugo dow - [X] Responsive - [X] Flexbox - [X] Typography (via ems) -- [X] Custom iconography +- [X] Custom iconography (i.e., via Fontello rather than FontAwesome bloat) - [X] Design assets versioned with source ([see design resources directory][designresources]) - [X] [WCAG color contrast requirements](http://webaim.org/blog/wcag-2-0-and-link-colors/) - [X] [Sass Guidelines for Source Organization](https://sass-guidelin.es/) @@ -194,7 +199,7 @@ The preceding analytics and metrics are separate from usage statics re: Hugo dow ## Annotated Content Changes -The following is an *abbreviated* listing of *substantive* changes made to the current documentation's source content and organization. Sections here are ordered according to the current site navigation. The changes delimited here do not include copy edits for consistent or preferred usage, improvements in semantics, etc, all of which easily numbers in the thousands, likely more. +The following is an *abbreviated* listing of *substantive* changes made to the current documentation's source content and organization. Sections here are ordered according to the current site navigation. The changes delimited here do *not* include copy edits for consistent or preferred usage, improvements in semantics, etc, all of which easily numbers in the thousands, likely more. ### Download Hugo @@ -203,22 +208,24 @@ This is no longer a site navigation link and is instead a button along with "Fil ### Site Showcase Site showcase has stayed more or less as is, including styling, etc. However... - * The showcase archetype has changed for simplicity. + * The showcase archetype has been refined for simplicity and now has new [contribution guidelines](/contribute/documentation). * To keep compatibility, all [showcase content files][showcasefiles] have been edited to reflect the new content type. This will also be updated in the ["docs" page of the contribute section](/contribute/documentation/) ### Press & Articles -* The press and article pages has been moved under "News" along with "Release Notes". Also, this whole section is lower on the navigation because it's less frequently visited---I'm assuming---than just about everything on the site. +* The press and article pages have been moved under "News" along with "Release Notes". Also, this whole section is lower on the navigation because it's less frequently visited---I'm assuming---than just about everything on the site. * Like everything else, I've kept up with changes to the docs upstream on GitHub, but in this case, I also includes a [half dozen *new* articles as well](/news/press-and-articles/). ### About Hugo -* Content is more or less the same, but I've cleaned up a lot of the language, and copy edited for consistency throughout. I've also added in some extra frills (e.g. resources that extoll and teach more about the benefits of SSGs on [/about/benefist](/about/benefits/)). +* Content is more or less the same, but I've cleaned up a lot of the language, and copy edited for consistency throughout. I've also added in some extra frills (e.g. resources that extoll and teach more about the benefits of SSGs on [/about/benefits](/about/benefits/)). * Release notes are now in the "News" section, although I'm still iffy on this decision. I can gladly move this back into "About" to give it a higher degree of discoverability in the menu. ### Getting Started -* The [Quick Start][] has been completely updated for more consistent heading structure, etc. Also, **I may delete the "deployment" section of the Quick Start** since this a) adds unnecessary length, making the guide less "quick" and b) detracts from the new "hosting and deployment" section, which offers better advice, and c) is redundant with [Hosting on Github](https://hugodocsconcept.netlify.com/hosting-and-deployment/hosting-on-github/). For example, the Quick Start didn't mention that files already written to public are not necessarily erased at build time. This can cause problems with drafts. I think the other options—e.g. Arjen's Wercker tutorial—are more viable and represent better practices for newcomers to Hugo. If future versions of Hugo include baked-in deployment features, I think it's worth reconsidering adding the deployment step back to the Quick Start. +* **[[UPDATE 2017-03-12]]** + * The Quick Start need to be completely reworked; this could include a walkthrough of a new default theme (#) +* ~~The [Quick Start][] has been completely updated for more consistent heading structure, etc. Also, **I may delete the "deployment" section of the Quick Start** since this a) adds unnecessary length, making the guide less "quick" and b) detracts from the new "hosting and deployment" section, which offers better advice, and c) is redundant with [Hosting on Github](https://hugodocsconcept.netlify.com/hosting-and-deployment/hosting-on-github/). For example, the Quick Start didn't mention that files already written to public are not necessarily erased at build time. This can cause problems with drafts. I think the other options—e.g. Arjen's Wercker tutorial—are more viable and represent better practices for newcomers to Hugo. If future versions of Hugo include baked-in deployment features, I think it's worth reconsidering adding the deployment step back to the Quick Start.~~ ### Content diff --git a/content/tutorials/_index.md b/content/tutorials/_index.md deleted file mode 100644 index 55cfb8f21..000000000 --- a/content/tutorials/_index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Tutorials -linktitle: Overview -description: -date: 2017-02-01 -publishdate: 2017-02-01 -lastmod: 2017-02-01 -tags: [tutorials,learning] -weight: 01 -draft: false -hidesectioncontents: false -slug: -aliases: -notesforauthors: ---- - -Hugo tutorials are developed and submitted by the Hugo community. - diff --git a/content/tutorials/creating-a-multilingual-site.md b/content/tutorials/creating-a-multilingual-site.md deleted file mode 100644 index 1ae4372b4..000000000 --- a/content/tutorials/creating-a-multilingual-site.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -title: Creating a Multilingual Site -linktitle: Multilingual Site -godocref: -description: -date: 2015-07-08 -publishdate: 2015-07-08 -lastmod: 2015-12-24 -categories: [tutorials] -tags: [internationalization,multilingual,i18n,tutorials] -authors: ["Rick Cogley"] -aliases: [/tutorials/create-a-multilingual-site/] -draft: false -toc: true -hugoversion: 16 ---- - -{{% note %}} -Since v0.17, Hugo has built-in support for the creation of multilingual websites. Read the [multilingual documentation](/content-management/multilingual/) for more information. -{{% /note %}} - -## Introduction - -Hugo allows you to create a multilingual site from its built-in tools. This tutorial will show one way to do it, and assumes: - -* You already know the basics about creating a Hugo site -* You have a separate domain name for each language -* You'll use `/data` files for some translation strings -* You'll use single, combined `layout` and `static` folders -* You'll use a subfolder for each language under `content` and `public` - -## Site Configs - -Create your site configs in the root of your repository, for example for an English and Japanese site. - -**English Config `config_en.toml`**: - -~~~toml -baseURL = "http://acme.com/" -title = "Acme Inc." -contentDir = "content/en" -publishDir = "public/en" - -[params] - locale = "en-US" -~~~ - -**Japanese Config `config_ja.toml`**: - -~~~toml -baseURL = "http://acme.jp/" -title = "有限会社アクミー" -contentDir = "content/ja" -publishDir = "public/ja" - -[params] - locale = "ja-JP" -~~~ - -If you had more domains and languages, you would just create more config files. The standard `config.toml` is what Hugo will run as a default, but since we're creating language-specific ones, you'll need to specify each config file when running `hugo server` or just `hugo` before deploying. - -## Prep Translation Strings in `/data` - -Create `.yaml` (or `.json` or `.toml`) files for each language, under `/data/translations`. - -**English Strings `en-US.yaml`**: - -~~~yaml -topSlogan: Acme Inc. -topSubslogan: You'll love us -... -~~~ - -**Japanese Strings `ja-JP.yaml`**: - -~~~yaml -topSlogan: 有限会社アクミー -topSubslogan: キット勝つぞ -... -~~~ - -In some cases, where there is more complex formatting within the strings you want to show, it might be better to employ some conditional logic in your template, to display a block of html per language. - -## Reference Strings in templates - -Now you can reference the strings in your templates. One way is to do it like in this `layouts/index.html`, leveraging the fact that you have the locale set: - -~~~html - - -... - - - {{ if eq .Site.Params.locale "en-US" }}{{ if .IsHome }}Welcome to {{ end }}{{ end }}{{ .Title }}{{ if eq .Site.Params.locale "ja-JP" }}{{ if .IsHome }}へようこそ{{ end }}{{ end }}{{ if ne .Title .Site.Title }} : {{ .Site.Title }}{{ end }} - ... - - -
-

{{ ( index $.Site.Data.translations $.Site.Params.locale ).topSlogan }}

-

{{ ( index $.Site.Data.translations $.Site.Params.locale ).topSubslogan }}

-
- - -~~~ - -The above shows both techniques, using an `if eq` and `else if eq` to check the locale, and using `index` to pull strings from the data file that matches the locale set in the site's config file. - -## Customize Dates - -At the time of this writing, Golang does not yet have support for internationalized locales, but if you do some work, you can simulate it. For example, if you want to use French month names, you can add a data file like ``data/mois.yaml`` with this content: - -~~~toml -1: "janvier" -2: "février" -3: "mars" -4: "avril" -5: "mai" -6: "juin" -7: "juillet" -8: "août" -9: "septembre" -10: "octobre" -11: "novembre" -12: "décembre" -~~~ - -... then index the non-English date names in your templates like so: - -~~~html - -~~~ - -This technique extracts the day, month and year by specifying ``.Date.Day``, ``.Date.Month``, and ``.Date.Year``, and uses the month number as a key, when indexing the month name data file. - -## Create Multilingual Content - -Now you can create markdown content in your languages, in the `content/en` and `content/ja` folders. The front matter stays the same on the key side, but the values would be set in each of the languages. - -## Run Hugo Server or Deploy Commands - -Once you have things set up, you can run `hugo server` or `hugo` before deploying. You can create scripts to do it, or as shell functions. Here are sample basic `zsh` functions: - -**Live Reload with `hugo server`**: - -~~~shell -function hugoserver-com { - cd /Users/me/dev/mainsite - hugo server --buildDrafts --verbose --source="/Users/me/dev/mainsite" --config="/Users/me/dev/mainsite/config_en.toml" --port=1377 -} -function hugoserver-jp { - cd /Users/me/dev/mainsite - hugo server --buildDrafts --verbose --source="/Users/me/dev/mainsite" --config="/Users/me/dev/mainsite/config_ja.toml" --port=1399 -} -~~~ - -**Deploy with `hugo` and `rsync`**: - -~~~shell -function hugodeploy-acmecom { - rm -rf /tmp/acme.com - hugo --config="/Users/me/dev/mainsite/config_en.toml" -s /Users/me/dev/mainsite/ -d /tmp/acme.com - rsync -avze "ssh -p 22" --delete /tmp/acme.com/ me@mywebhost.com:/home/me/webapps/acme_com_site -} - -function hugodeploy-acmejp { - rm -rf /tmp/acme.jp - hugo --config="/Users/me/dev/mainsite/config_ja.toml" -s /Users/me/dev/mainsite/ -d /tmp/acme.jp - rsync -avze "ssh -p 22" --delete /tmp/acme.jp/ me@mywebhost.com:/home/me/webapps/acme_jp_site -} -~~~ - -Adjust to fit your situation, setting dns, your webserver config, and other settings as appropriate. \ No newline at end of file diff --git a/content/tutorials/creating-a-new-theme.md b/content/tutorials/creating-a-new-theme.md deleted file mode 100644 index 91dd5bac7..000000000 --- a/content/tutorials/creating-a-new-theme.md +++ /dev/null @@ -1,1503 +0,0 @@ ---- -title: Creating a New Theme -linktitle: -description: -date: 2015-11-26 -publishdate: 2015-11-26 -lastmod: 2017-02-01 -categories: [tutorials] -tags: [themes] -authors: ["Michael Henderson"] -aliases: [] -hugoversion: 18.1 -draft: true -toc: 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. - -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. - -## 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 `#`. - -So, for example: - -```bash -# this is a comment -$ echo this is a command -this is a command - -# edit the file - -$ vi foo.md - -+++ -date = "2040-01-18" -title = "creating a new theme" - -+++ -Bah! Humbug! -:wq - -# show it -$ cat foo.md -+++ -date = "2040-01-18" -title = "creating a new theme" - -+++ -Bah! Humbug! -``` - -## Definitions - -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_ - -### Non-Content - -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 -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. - -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. - -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. - -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. - -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. - -### Home - -The homepage, 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 homepage 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. - -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. - -### Template - -_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. - -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. - -### 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 - -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. - -#### 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. - -### 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. - -#### 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. - -#### 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). - -The homepage template is a special kind of List template. This is because Hugo assumes that your homepage 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. - -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: - -```bash -$ cd /tmp/ - -$ hugo new site mySite - -$ cd mySite/ - -$ ls -l -total 8 -drwxr-xr-x 2 {user} {group} 68 {date} archetypes --rw-r--r-- 1 {user} {group} 107 {date} config.toml -drwxr-xr-x 2 {user} {group} 68 {date} content -drwxr-xr-x 2 {user} {group} 68 {date} data -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. - -### 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: - -```bash -$ hugo --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -WARN: {date} {source} No theme set -INFO: {date} {source} /tmp/mySite/static/ is the only static directory available to sync from -INFO: {date} {source} syncing static files to /tmp/mySite/public/ -Started building site -WARN: {date} {source} Unable to locate layout for homepage: [index.html _default/list.html] -WARN: {date} {source} "/" is rendered empty -============================================================= -Your rendered homepage is blank: /index.html is zero-length - * Did you specify a theme on the command-line or in your - "config.toml" file? (Current theme: "") -============================================================= -WARN: {date} {source} Unable to locate layout for 404 page: [404.html] -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -0 pages created -0 non-page files copied -0 paginator pages created -0 tags created -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. - -We can verify that the command worked by looking at the directory again: - -```bash -$ ls -l -total 8 -drwxr-xr-x 2 {user} {group} 68 {date} archetypes --rw-r--r-- 1 {user} {group} 107 {date} config.toml -drwxr-xr-x 2 {user} {group} 68 {date} content -drwxr-xr-x 2 {user} {group} 68 {date} data -drwxr-xr-x 2 {user} {group} 68 {date} layouts -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: - -```bash -$ ls -l public/ -total 16 --rw-r--r-- 1 {user} {group} 0 {date} 404.html --rw-r--r-- 1 {user} {group} 0 {date} index.html --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: - -```bash -0 pages created -``` - -That's because Hugo doesn't count the homepage, 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: - -```bash -$ hugo server --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -WARN: {date} {source} No theme set -INFO: {date} {source} /tmp/mySite/static/ is the only static directory available to sync from -INFO: {date} {source} syncing static files to / -WARN: {date} {source} Unable to locate layout for homepage: [index.html _default/list.html] -WARN: {date} {source} "/" is rendered empty -============================================================= -Your rendered homepage is blank: /index.html is zero-length - * Did you specify a theme on the command-line or in your - "config.toml" file? (Current theme: "") -============================================================= -WARN: {date} {source} Unable to locate layout for 404 page: [404.html] -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -0 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -in 3 ms -Watching for changes in /tmp/mySite/{data,content,layouts,static} -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 homepage warning: the first layout Hugo looked for was `layouts/index.html`. Note that Hugo uses this file for the homepage only. - -It's good that Hugo lists the files it seeks, when we give it the verbose flag. For the homepage, 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 homepage, 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. - -## 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. - -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. - -### 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: - -```bash -$ hugo new theme zafta - -$ find themes -type f | xargs ls -l --rw-r--r-- 1 {user} {group} 8 {date} themes/zafta/archetypes/default.md --rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/404.html --rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/_default/list.html --rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/_default/single.html --rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/index.html --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 --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. - -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 --rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/_default/list.html --rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/_default/single.html --rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/index.html --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 -to add its name to the configuration file. This is optional, because -it's possible to add "-t zafta" to all your commands. -I like to put it in the configuration file because I like -shorter command lines. If you don't put it in the configuration file, -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" -baseURL = "http://example.org/" -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 -INFO: {date} {source} using a UnionFS for static directory comprised of: -INFO: {date} {source} Base: /tmp/mySite/themes/zafta/static -INFO: {date} {source} Overlay: /tmp/mySite/static/ -INFO: {date} {source} syncing static files to /tmp/mySite/public/ -Started building site -WARN: {date} {source} "/" is rendered empty -============================================================= -Your rendered homepage is blank: /index.html is zero-length - * Did you specify a theme on the command-line or in your - "config.toml" file? (Current theme: "zafta") -============================================================= -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -0 pages created -0 non-page files copied -0 paginator pages created -0 tags created -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 homepage 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 --rw-r--r-- 1 {user} {group} 0 {date} 404.html -drwxr-xr-x 2 {user} {group} 68 {date} css --rw-r--r-- 1 {user} {group} 0 {date} index.html --rw-r--r-- 1 {user} {group} 511 {date} index.xml -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: - -```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 homepage 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 homepage's HTML. Although Hugo's documentation may state that this file is the homepage'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] -``` -#### Empty - -When Hugo generated your theme, it included an empty homepage template. -Whenever Hugo renders your website, it seeks that same template and uses it -to render the HTML for the homepage. Currently, the template file is empty, -so the output HTML file is empty, too. Whenever we add rules to that template, -Hugo will use them in rendering the homepage: -```bash -$ find * -name index.html | xargs ls -l --rw-r--r-- 1 {user} {group} 0 {date} public/index.html --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. -Besides using templates to transform your content into HTML, -it also incorporates your static files. Hugo's rule is simple: -unlike with templates and content, static files aren't transformed. -Hugo copies them over, exactly as they are. - -Hugo assumes that your website will use both CSS and JavaScript, -so it generates some directories in your theme to hold them. -Remember opinions? Well, Hugo's opinion is that you'll store your CSS -in directory `static/css/`, and your JavaScript in directory `static/js/`. -If you don't like that, you can relocate these directories -or change their names (as long as they remain in your theme's `static/` tree), -or delete them completely. -Hugo is nice enough to offer its opinion; yet it still behaves nicely, -if you disagree: -```bash -$ find themes/zafta/* -type d | xargs ls -dl -drwxr-xr-x 3 {user} {group} 102 {date} themes/zafta/archetypes -drwxr-xr-x 6 {user} {group} 204 {date} themes/zafta/layouts -drwxr-xr-x 4 {user} {group} 136 {date} themes/zafta/layouts/_default -drwxr-xr-x 4 {user} {group} 136 {date} themes/zafta/layouts/partials -drwxr-xr-x 4 {user} {group} 136 {date} themes/zafta/static -drwxr-xr-x 2 {user} {group} 68 {date} themes/zafta/static/css -drwxr-xr-x 2 {user} {group} 68 {date} themes/zafta/static/js -``` -## Theme Development - -Generally (using any kind of software), working on a theme means -changing your files, serving your website again, and then verifying -the resulting improvements in your browser. -With Hugo, this way of working is quite easy: - -- First purge the `./public/` tree. (This is optional but useful, -if you want to start with a clean slate.) -- Run the built-in Hugo web server. -- Open your website in a browser — and then: - -1. Edit your theme; -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! - -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 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. - -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. - -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!" - -### 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/ - -# run Hugo in watch mode with LiveReload; -# when you're done, stop the web server -$ hugo server --verbose -Press Ctrl+C to stop -``` - -Below is some sample output showing Hugo detecting a change in the homepage 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/ - -$ hugo server --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -INFO: {date} {source} using a UnionFS for static directory comprised of: -INFO: {date} {source} Base: /tmp/mySite/themes/zafta/static -INFO: {date} {source} Overlay: /tmp/mySite/static/ -INFO: {date} {source} syncing static files to / -Started building site -WARN: {date} {source} "/" is rendered empty -============================================================= -Your rendered homepage is blank: /index.html is zero-length - * Did you specify a theme on the command-line or in your - "config.toml" file? (Current theme: "") -============================================================= -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -0 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -in 4 ms -Watching for changes in /tmp/mySite/{data,content,layouts,static,themes} -Serving pages from memory -Web Server is available at http://localhost:1313/ (bind address 127.0.0.1) -Press Ctrl+C to stop -INFO: {date} {source} Received System Events: ["/tmp/mySite/themes/zafta/layouts/index.html": WRITE] - -Change detected, rebuilding site -{date} -Template changed /tmp/mySite/themes/zafta/layouts/index.html -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -0 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -in 3 ms -``` -## Home Template - -The homepage 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. - -### Static - -Right now, your homepage 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 homepage template (`layouts/index.html`): - -```html -$ vi themes/zafta/layouts/index.html - - - -

Hugo says hello!

- - -:wq -``` - -Let's press Ctrl+C and render the website, and then verify the results: - -```html -$ rm -rf public/ - -$ hugo --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -INFO: {date} {source} using a UnionFS for static directory comprised of: -INFO: {date} {source} Base: /tmp/mySite/themes/zafta/static -INFO: {date} {source} Overlay: /tmp/mySite/static/ -INFO: {date} {source} syncing static files to /tmp/mySite/public/ -Started building site -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -0 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -in 4 ms - -$ ls -l public/index.html --rw-r--r-- 1 {user} {group} 72 {date} public/index.html - -$ cat public/index.html - - - -

Hugo says hello!

- - -``` - -### Dynamic - -A ***dynamic*** homepage? Because Hugo is a _static website_ generator, the word _dynamic_ seems odd, doesn't it? But this means arranging for your homepage to reflect the content in your website automatically, each time Hugo renders it. - -To accomplish that, later we'll add an iterator to your homepage template. - -## Article - -Now that Hugo is successfully rendering your homepage with static content, let's add more pages to your website. We'll display some new articles as a list on your homepage; 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 -INFO: {date} {source} attempting to create article/First.md of article -INFO: {date} {source} curpath: /tmp/mySite/themes/zafta/archetypes/default.md -INFO: {date} {source} creating /tmp/mySite/content/article/First.md -/tmp/mySite/content/article/First.md created - -$ ls -l content/article/ -total 8 --rw-r--r-- 1 {user} {group} 61 {date} First.md -``` -Let's generate a second article, while we're here: -```bash -$ hugo --verbose new article/Second.md -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -INFO: {date} {source} attempting to create article/Second.md of article -INFO: {date} {source} curpath: /tmp/mySite/themes/zafta/archetypes/default.md -INFO: {date} {source} creating /tmp/mySite/content/article/Second.md -/tmp/mySite/content/article/Second.md created - -$ ls -l content/article/ -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, -but append some text to their bodies, as follows: -```bash -$ vi content/article/First.md -In vel ligula tortor. Aliquam erat volutpat. -Pellentesque at felis eu quam tincidunt dignissim. -Nulla facilisi. - -Pellentesque tempus nisi et interdum convallis. -In quam ante, vulputate at massa et, rutrum -gravida dui. Phasellus tristique libero at ex. -:wq - -$ vi content/article/Second.md -Fusce lacus magna, maximus nec sapien eu, -porta efficitur neque. Aliquam erat volutpat. -Vestibulum enim nibh, posuere eu diam nec, -varius sagittis turpis. - -Praesent quis sapien egestas mauris accumsan -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 -+++ -date = "2040-01-18T21:08:08-06:00" -title = "Second" - -+++ -Fusce lacus magna, maximus nec sapien eu, -porta efficitur neque. Aliquam erat volutpat. -Vestibulum enim nibh, posuere eu diam nec, -varius sagittis turpis. - -Praesent quis sapien egestas mauris accumsan -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/ - -$ hugo --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -INFO: {date} {source} using a UnionFS for static directory comprised of: -INFO: {date} {source} Base: /tmp/mySite/themes/zafta/static -INFO: {date} {source} Overlay: /tmp/mySite/static/ -INFO: {date} {source} syncing static files to /tmp/mySite/public/ -Started building site -INFO: {date} {source} found taxonomies: map[string]string{"tag":"tags", "category":"categories"} -WARN: {date} {source} "article" is rendered empty -WARN: {date} {source} "article/Second.html" is rendered empty -WARN: {date} {source} "article/First.html" is rendered empty -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -2 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -in 7 ms -``` - -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 --rw-r--r-- 1 {user} {group} 0 {date} public/article/First/index.html --rw-r--r-- 1 {user} {group} 0 {date} public/article/index.html --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 homepage doesn't show us the new content, either: - -```html -$ cat public/index.html - - - -

Hugo says hello!

- - -``` - -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 homepage template we edited previously; it's applicable only to the homepage. 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 homepage 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, -we won't go into much detail about these. - -### Home - -You'll want your homepage 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 - - - - {{- range first 10 .Data.Pages }} -

{{ .Title }}

- {{- end }} - - -:wq -``` - -#### Engine - -Hugo uses the [Go language's template -engine](https://gohugo.io/templates/introduction/). -That engine scans your template files for commands enclosed between -"{{" and "}}" (these are doubled, curly braces — affectionately -known as "mustaches"). - -BTW, a hyphen, if placed immediately after an opening mustache, or -immediately before a closing one, will prevent extraneous newlines. -(This can make Hugo's output look better, when viewed as text.) - -So, the mustache commands in your newly-altered template are: - -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.) - -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 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. - -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. - -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/ - -$ hugo --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -INFO: {date} {source} using a UnionFS for static directory comprised of: -INFO: {date} {source} Base: /tmp/mySite/themes/zafta/static -INFO: {date} {source} Overlay: /tmp/mySite/static/ -INFO: {date} {source} syncing static files to /tmp/mySite/public/ -Started building site -INFO: {date} {source} found taxonomies: map[string]string{"tag":"tags", "category":"categories"} -WARN: {date} {source} "article" is rendered empty -WARN: {date} {source} "article/Second.html" is rendered empty -WARN: {date} {source} "article/First.html" is rendered empty -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -2 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -in 7 ms - -$ find public -type f -name '*.html' | xargs ls -l --rw-r--r-- 1 {user} {group} 0 {date} public/404.html --rw-r--r-- 1 {user} {group} 0 {date} public/article/First/index.html --rw-r--r-- 1 {user} {group} 0 {date} public/article/index.html --rw-r--r-- 1 {user} {group} 0 {date} public/article/Second/index.html --rw-r--r-- 1 {user} {group} 232 {date} public/index.html - -$ cat public/index.html - - - -

Second

-

First

- - -``` - -### All Done - -Congratulations! Your homepage 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 homepage 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. - -## 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. - -### 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. - -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". - -#### 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`. - -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. - -#### Default Single - -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. - -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. - -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 - - - - {{ .Title }} - - -

{{ .Title }}

-
{{ .Date.Format "Mon, Jan 2, 2006" }}
- {{ .Content }} -

Home

- - -:wq -``` - -#### Verify - -Let's render the website, and verify the results: - -```bash -$ rm -rf public/ - -$ hugo --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -INFO: {date} {source} using a UnionFS for static directory comprised of: -INFO: {date} {source} Base: /tmp/mySite/themes/zafta/static -INFO: {date} {source} Overlay: /tmp/mySite/static/ -INFO: {date} {source} syncing static files to /tmp/mySite/public/ -Started building site -INFO: {date} {source} found taxonomies: map[string]string{"tag":"tags", "category":"categories"} -WARN: {date} {source} "article" is rendered empty -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -2 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -in 7 ms - -$ find public -type f -name '*.html' | xargs ls -l --rw-r--r-- 1 {user} {group} 0 {date} public/404.html --rw-r--r-- 1 {user} {group} 473 {date} public/article/First/index.html --rw-r--r-- 1 {user} {group} 0 {date} public/article/index.html --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 - - - - First - - -

First

-
Wed, Jan 18, 2040
-

In vel ligula tortor. Aliquam erat volutpat. -Pellentesque at felis eu quam tincidunt dignissim. -Nulla facilisi.

- -

Pellentesque tempus nisi et interdum convallis. -In quam ante, vulputate at massa et, rutrum -gravida dui. Phasellus tristique libero at ex.

- -

Home

- - - -$ cat public/article/Second/index.html - - - - Second - - -

Second

-
Wed, Jan 18, 2040
-

Fusce lacus magna, maximus nec sapien eu, -porta efficitur neque. Aliquam erat volutpat. -Vestibulum enim nibh, posuere eu diam nec, -varius sagittis turpis.

- -

Praesent quis sapien egestas mauris accumsan -pulvinar. Ut mattis gravida venenatis. Vivamus -lobortis risus id nisi rutrum, at iaculis.

- -

Home

- - -``` - -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 homepage, 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 homepage. - -### Article List - -Your homepage 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 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: - -```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`. - -#### Default List - -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 - - - -

Articles

- {{- range first 10 .Data.Pages }} -

{{ .Title }}

- {{- end }} -

Home

- - -:wq -``` - -Let's render everything again: - -```bash -$ rm -rf public/ - -$ hugo --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -INFO: {date} {source} using a UnionFS for static directory comprised of: -INFO: {date} {source} Base: /tmp/mySite/themes/zafta/static -INFO: {date} {source} Overlay: /tmp/mySite/static/ -INFO: {date} {source} syncing static files to /tmp/mySite/public/ -Started building site -INFO: {date} {source} found taxonomies: map[string]string{"tag":"tags", "category":"categories"} -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -2 pages created -0 non-page files copied -0 paginator pages created -0 categories created -0 tags created -in 7 ms - -$ find public -type f -name '*.html' | xargs ls -l --rw-r--r-- 1 {user} {group} 0 {date} public/404.html --rw-r--r-- 1 {user} {group} 473 {date} public/article/First/index.html --rw-r--r-- 1 {user} {group} 327 {date} public/article/index.html --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.) - -## 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). - -### 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: - -```toml -$ hugo new About.md -/tmp/mySite/content/About.md created - -$ ls -l content/ -total 8 --rw-r--r-- 1 {user} {group} 61 {date} About.md -drwxr-xr-x 4 {user} {group} 136 {date} article - -$ vi content/About.md -+++ -date = "2040-01-18T22:01:00-06:00" -title = "About" - -+++ -Neque porro quisquam est qui dolorem -ipsum quia dolor sit amet consectetur -adipisci velit. -:wq -``` - -### Check - -Let's render your website, and check the results: - -```html -$ rm -rf public/ - -$ hugo --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -INFO: {date} {source} using a UnionFS for static directory comprised of: -INFO: {date} {source} Base: /tmp/mySite/themes/zafta/static -INFO: {date} {source} Overlay: /tmp/mySite/static/ -INFO: {date} {source} syncing static files to /tmp/mySite/public/ -Started building site -INFO: {date} {source} found taxonomies: map[string]string{"tag":"tags", "category":"categories"} -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -3 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -in 9 ms - -$ ls -l public/ -total 24 --rw-r--r-- 1 {user} {group} 0 {date} 404.html -drwxr-xr-x 3 {user} {group} 102 {date} About -drwxr-xr-x 6 {user} {group} 204 {date} article -drwxr-xr-x 2 {user} {group} 68 {date} css --rw-r--r-- 1 {user} {group} 316 {date} index.html --rw-r--r-- 1 {user} {group} 2221 {date} index.xml -drwxr-xr-x 2 {user} {group} 68 {date} js --rw-r--r-- 1 {user} {group} 681 {date} sitemap.xml - -$ ls -l public/About/ -total 8 --rw-r--r-- 1 {user} {group} 305 {date} index.html - -$ cat public/About/index.html - - - - About - - -

About

-
Wed, Jan 18, 2040
-

Neque porro quisquam est qui dolorem -ipsum quia dolor sit amet consectetur -adipisci velit.

- -

Home

- - -``` - -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 homepage: - -```html -$ cat public/index.html - - - -

About

-

Second

-

First

- - -``` - -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 homepage template -(`layouts/index.html`): - -```html -$ vi themes/zafta/layouts/index.html - - - -

Articles

- {{- range first 10 .Data.Pages -}} - {{- if eq .Type "article"}} -

{{ .Title }}

- {{- end -}} - {{- end }} -

Pages

- {{- range first 10 .Data.Pages -}} - {{- if eq .Type "page" }} -

{{ .Title }}

- {{- end -}} - {{- end }} - - -:wq -``` - -Let's render your website, and verify the results: - -```html -$ rm -rf public/ - -$ hugo --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -INFO: {date} {source} using a UnionFS for static directory comprised of: -INFO: {date} {source} Base: /tmp/mySite/themes/zafta/static -INFO: {date} {source} Overlay: /tmp/mySite/static/ -INFO: {date} {source} syncing static files to /tmp/mySite/public/ -Started building site -INFO: {date} {source} found taxonomies: map[string]string{"tag":"tags", "category":"categories"} -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -3 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -in 9 ms - -$ cat public/index.html - - - -

Articles

-

Second

-

First

-

Pages

-

About

- - -``` - -Good! This time, your homepage 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 homepage doesn't show its title in your browser, although both of your article pages do. That's because we didn't add your homepage'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. - -### 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`): - -```html -$ vi themes/zafta/layouts/partials/header.html - - - - {{ .Title }} - - -:wq - -$ vi themes/zafta/layouts/partials/footer.html -

Home

- - -: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: - -```bash -{{ partial "header.html" . }} -``` - -#### From Home - -Let's change your homepage 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" . }} -

Articles

- {{- range first 10 .Data.Pages -}} - {{- if eq .Type "article"}} -

{{ .Title }}

- {{- end -}} - {{- end }} -

Pages

- {{- range first 10 .Data.Pages -}} - {{- if eq .Type "page" }} -

{{ .Title }}

- {{- end -}} - {{- end }} - - -:wq -``` - -Render your website and verify the results. Now, the title on your homepage 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" . }} -

{{ .Title }}

-
{{ .Date.Format "Mon, Jan 2, 2006" }}
- {{ .Content }} -{{ partial "footer.html" . -}} -:wq - -$ vi themes/zafta/layouts/_default/list.html -{{ partial "header.html" . -}} -

Articles

- {{- range first 10 .Data.Pages }} -

{{ .Title }}

- {{- end }} -{{ 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`). - -### 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. - -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. - -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: - -```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 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 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" . }} -

{{ .Title }}

- {{ .Content }} -{{ 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: - -```html -$ mkdir themes/zafta/layouts/article - -$ vi themes/zafta/layouts/article/single.html -{{ partial "header.html" . }} -

{{ .Title }}

-
{{ .Date.Format "Mon, Jan 2, 2006" }}
- {{ .Content }} -{{ 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`. - -Let's render your website and verify the results: - -```html -$ rm -rf public/ - -$ hugo --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -INFO: {date} {source} using a UnionFS for static directory comprised of: -INFO: {date} {source} Base: /tmp/mySite/themes/zafta/static -INFO: {date} {source} Overlay: /tmp/mySite/static/ -INFO: {date} {source} syncing static files to /tmp/mySite/public/ -Started building site -INFO: {date} {source} found taxonomies: map[string]string{"tag":"tags", "category":"categories"} -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -3 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -in 10 ms - -$ cat public/article/First/index.html - - - - First - - - -

First

-
Wed, Jan 18, 2040
-

In vel ligula tortor. Aliquam erat volutpat. -Pellentesque at felis eu quam tincidunt dignissim. -Nulla facilisi.

- -

Pellentesque tempus nisi et interdum convallis. -In quam ante, vulputate at massa et, rutrum -gravida dui. Phasellus tristique libero at ex.

- -

Home

- - - -$ cat public/About/index.html - - - - About - - - -

About

-

Neque porro quisquam est qui dolorem -ipsum quia dolor sit amet consectetur -adipisci velit.

- -

Home

- - -``` - -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 deleted file mode 100644 index 68b4b6a82..000000000 --- a/content/tutorials/migrate-from-jekyll-to-hugo.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -title: Migrate from Jekyll Hugo -linktitle: Migrate from Jekyll to Hugo -description: This tutorial walks you through converting your Jekyll site to a Hugo site through examples of the differences between Jekyll and Hugo templating. Note that v0.15 and above of Hugo has a built-in `hugo import jekyll` command to greatly facilitate this task. -date: 2017-02-01 -publishdate: 2017-02-01 -lastmod: 2017-02-01 -categories: [tutorials] -tags: [migrations,jekyll, command line] -authors: [Alexandre Normand] -weight: -draft: false -hugoversion: 14 -toc: true -aliases: [/tutorials/migrate-from-jekyll/] -wip: true ---- - -{{% note "Support for Jekyll Imports" %}} -Hugo 0.15 comes with a `hugo import jekyll` command, see [import from Jekyll](/commands/hugo_import_jekyll/). -{{% /note %}} - -## Move static content to `static` - -Jekyll has a rule that any directory not starting with `_` will be copied as-is to the `_site` output. Hugo keeps all static content under `static`. You should therefore move it all there. - -With Jekyll, something that looked like - -```bash -▾ / - ▾ images/ - logo.png -``` - -should become - -```bash -▾ / - ▾ static/ - ▾ images/ - logo.png -``` - -Additionally, you'll want any files that should reside at the root (e.g., `CNAME`) to be moved to the `static` directory. - -## Create your Hugo Configuration File - -Hugo can read your configuration as JSON, YAML or TOML. Hugo supports parameters custom configuration too. Refer to the [Hugo configuration documentation](/overview/configuration/) for details. - -## Set Your Configuration Publish Folder to `_site` - -The default is for Jekyll to publish to `_site` and for Hugo to publish to `public`. If, like me, you have [`_site` mapped to a git submodule on the `gh-pages` branch](http://blog.blindgaenger.net/generate_github_pages_in_a_submodule.html), you'll want to do one of two alternatives: - -1. Change your submodule to point to map `gh-pages` to public instead of `_site` (recommended). - -``` -git submodule deinit _site -git rm _site -git submodule add -b gh-pages git@github.com:your-username/your-repo.git public -``` - -2. Or, change the Hugo configuration to use `_site` instead of `public`. - -``` -{ - .. - "publishDir": "_site", - .. -} -``` - -## Convert Jekyll templates to Hugo templates - -That's the bulk of the work right here. The documentation is your friend. You should refer to [Jekyll's template documentation](http://jekyllrb.com/docs/templates/) if you need to refresh your memory on how you built your blog and [Hugo's template](/layout/templates/) to learn Hugo's way. - -As a single reference data point, converting my templates for [heyitsalex.net](http://heyitsalex.net/) took me no more than a few hours. - -## Convert Jekyll Plugins to Hugo shortcodes - -Jekyll has [plugins](http://jekyllrb.com/docs/plugins/); Hugo has [shortcodes](/doc/shortcodes/). It's fairly trivial to do a port. - -### Implementation - -As an example, I was using a custom [`image_tag`](https://github.com/alexandre-normand/alexandre-normand/blob/74bb12036a71334fdb7dba84e073382fc06908ec/_plugins/image_tag.rb) plugin to generate figures with caption when running Jekyll. As I read about shortcodes, I found Hugo had a nice built-in shortcode that does exactly the same thing. - -Jekyll's plugin: - -```ruby -module Jekyll - class ImageTag < Liquid::Tag - @url = nil - @caption = nil - @class = nil - @link = nil - // Patterns - IMAGE_URL_WITH_CLASS_AND_CAPTION = - IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK = /(\w+)(\s+)((https?:\/\/|\/)(\S+))(\s+)"(.*?)"(\s+)->((https?:\/\/|\/)(\S+))(\s*)/i - IMAGE_URL_WITH_CAPTION = /((https?:\/\/|\/)(\S+))(\s+)"(.*?)"/i - IMAGE_URL_WITH_CLASS = /(\w+)(\s+)((https?:\/\/|\/)(\S+))/i - IMAGE_URL = /((https?:\/\/|\/)(\S+))/i - def initialize(tag_name, markup, tokens) - super - if markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK - @class = $1 - @url = $3 - @caption = $7 - @link = $9 - elsif markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION - @class = $1 - @url = $3 - @caption = $7 - elsif markup =~ IMAGE_URL_WITH_CAPTION - @url = $1 - @caption = $5 - elsif markup =~ IMAGE_URL_WITH_CLASS - @class = $1 - @url = $3 - elsif markup =~ IMAGE_URL - @url = $1 - end - end - def render(context) - if @class - source = "
" - else - source = "
" - end - if @link - source += "" - end - source += "" - if @link - source += "" - end - source += "
#{@caption}
" if @caption - source += "
" - source - end - end -end -Liquid::Template.register_tag('image', Jekyll::ImageTag) -``` - -is written as this Hugo shortcode: - -```html - -
- {{ with .Get "link"}}{{ end }} - - {{ if .Get "link"}}{{ end }} - {{ if or (or (.Get "title") (.Get "caption")) (.Get "attr")}} -
{{ if isset .Params "title" }} - {{ .Get "title" }}{{ end }} - {{ if or (.Get "caption") (.Get "attr")}}

- {{ .Get "caption" }} - {{ with .Get "attrlink"}} {{ end }} - {{ .Get "attr" }} - {{ if .Get "attrlink"}} {{ end }} -

{{ end }} -
- {{ end }} -
- -``` - -### Usage -I simply changed: - -{% image full http://farm5.staticflickr.com/4136/4829260124_57712e570a_o_d.jpg "One of my favorite touristy-type photos. I secretly waited for the good light while we were "having fun" and took this. Only regret: a stupid pole in the top-left corner of the frame I had to clumsily get rid of at post-processing." ->http://www.flickr.com/photos/alexnormand/4829260124/in/set-72157624547713078/ %} - -to this (this example uses a slightly extended version named `fig`, different than the built-in `figure`): - -{{%/* fig class="full" src="http://farm5.staticflickr.com/4136/4829260124_57712e570a_o_d.jpg" title="One of my favorite touristy-type photos. I secretly waited for the good light while we were having fun and took this. Only regret: a stupid pole in the top-left corner of the frame I had to clumsily get rid of at post-processing." link="http://www.flickr.com/photos/alexnormand/4829260124/in/set-72157624547713078/" */%}} - -As a bonus, the shortcode named parameters are, arguably, more readable. - -## Finishing touches - -### Fix content - -Depending on the amount of customization that was done with each post with Jekyll, this step will require more or less effort. There are no hard and fast rules here except that `hugo server` is your friend. Test your changes and fix errors as needed. - -### Clean up -You'll want to remove the Jekyll configuration at this point. If you have anything else that isn't used, delete it. - -## A Practical Example in a Diff - -[Hey, it's Alex](http://heyitsalex.net/) was migrated in less than a _father-with-kids day_ from Jekyll to Hugo. You can see all the changes (and screw-ups) by looking at this [diff](https://github.com/alexandre-normand/alexandre-normand/compare/869d69435bd2665c3fbf5b5c78d4c22759d7613a...b7f6605b1265e83b4b81495423294208cc74d610). \ No newline at end of file diff --git a/layouts/_default/terms.html b/layouts/_default/terms.html index 2cfe8d85b..544c5fed4 100644 --- a/layouts/_default/terms.html +++ b/layouts/_default/terms.html @@ -19,7 +19,7 @@ {{$val := $value.Name | urlize}} {{$valurl := add $dataPlural $val}} - {{ $value.Name }} + {{ replace $value.Name "-" " " }} {{ $value.Count }} {{ end }}