diff --git a/docs/content/tutorials/creating-a-new-theme.md b/docs/content/tutorials/creating-a-new-theme.md index 6936d9a22..78e82528e 100644 --- a/docs/content/tutorials/creating-a-new-theme.md +++ b/docs/content/tutorials/creating-a-new-theme.md @@ -1,6 +1,6 @@ --- author: "Michael Henderson" -date: 2014-09-28 +date: 2015-11-26 linktitle: Creating a New Theme toc: true menu: @@ -17,31 +17,31 @@ weight: 10 This tutorial will show you how to create a simple theme in Hugo. I assume that you are familiar with HTML, the bash command line, and that you are comfortable using Markdown to format content. I'll explain how Hugo uses templates and how you can organize your templates to create a theme. I won't cover using CSS to style your theme. -We'll start with creating a new site with a very basic template. Then we'll add in a few pages and posts. With small variations on that, you will be able to create many different types of web sites. +We'll start with creating a new site with a very basic template. Then we'll add in a few articles and an about page. With small variations on that, you will be able to create many different types of web sites. -In this tutorial, commands that you enter will start with the "$" prompt. The output will follow. Lines that start with "#" are comments that I've added to explain a point. When I show updates to a file, the ":wq" on the last line means to save the file. +In this tutorial, commands that you enter will start with the `$` prompt. The output will follow. Lines that start with `#` are comments that I've added to explain a point. When I show updates to a file, the `:wq` on the last line means to save the file. Here's an example: -``` -## this is a comment +```bash +# this is a comment $ echo this is a command this is a command -## edit the file -$vi foo.md +# edit the file +$ vi foo.md +++ -date = "2014-09-28" +date = "2015-11-26" title = "creating a new theme" +++ bah and humbug :wq -## show it +# show it $ cat foo.md +++ -date = "2014-09-28" +date = "2015-11-26" title = "creating a new theme" +++ @@ -58,33 +58,33 @@ There are a few concepts that you need to understand before creating a theme. Skins are the files responsible for the look and feel of your site. It’s the CSS that controls colors and fonts, it’s the Javascript that determines actions and reactions. It’s also the rules that Hugo uses to transform your content into the HTML that the site will serve to visitors. -You have two ways to create a skin. The simplest way is to create it in the ```layouts/``` directory. If you do, then you don’t have to worry about configuring Hugo to recognize it. The first place that Hugo will look for rules and files is in the ```layouts/``` directory so it will always find the skin. +You have two ways to create a skin. The simplest way is to create it in the `layouts/` directory. If you do, then you don’t have to worry about configuring Hugo to recognize it. The first place that Hugo will look for rules and files is in the `layouts/` directory so it will always find the skin. -Your second choice is to create it in a sub-directory of the ```themes/``` directory. If you do, then you must always tell Hugo where to search for the skin. It’s extra work, though, so why bother with it? +Your second choice is to create it in a sub-directory of the `themes/` directory. If you do, then you must always tell Hugo where to search for the skin. It’s extra work, though, so why bother with it? -The difference between creating a skin in ```layouts/``` and creating it in ```themes/``` is very subtle. A skin in ```layouts/``` can’t be customized without updating the templates and static files that it is built from. A skin created in ```themes/```, on the other hand, can be and that makes it easier for other people to use it. +The difference between creating a skin in `layouts/` and creating it in `themes/` is very subtle. A skin in `layouts/` can’t be customized without updating the templates and static files that it is built from. A skin created in `themes/`, on the other hand, can be and that makes it easier for other people to use it. -The rest of this tutorial will call a skin created in the ```themes/``` directory a theme. +The rest of this tutorial will call a skin created in the `themes/` directory a theme. -Note that you can use this tutorial to create a skin in the ```layouts/``` directory if you wish to. The main difference will be that you won’t need to update the site’s configuration file to use a theme. +Note that you can use this tutorial to create a skin in the `layouts/` directory if you wish to. The main difference will be that you won’t need to update the site’s configuration file to use a theme. ### The Home Page -The home page, or landing page, is the first page that many visitors to a site see. It is the index.html file in the root directory of the web site. Since Hugo writes files to the public/ directory, our home page is public/index.html. +The home page, or landing page, is the first page that many visitors to a site see. It is the `index.html` file in the root directory of the web site. Since Hugo writes files to the `public/` directory, our home page is `public/index.html`. ### Site Configuration File When Hugo runs, it looks for a configuration file that contains settings that override default values for the entire site. The file can use TOML, YAML, or JSON. I prefer to use TOML for my configuration files. If you prefer to use JSON or YAML, you’ll need to translate my examples. You’ll also need to change the name of the file since Hugo uses the extension to determine how to process it. -Hugo translates Markdown files into HTML. By default, Hugo expects to find Markdown files in your ```content/``` directory and template files in your ```themes/``` directory. It will create HTML files in your ```public/``` directory. You can change this by specifying alternate locations in the configuration file. +Hugo translates Markdown files into HTML. By default, Hugo expects to find Markdown files in your `content/` directory and template files in your `themes/` directory. It will create HTML files in your `public/` directory. You can change this by specifying alternate locations in the configuration file. ### Content -Content is stored in text files that contain two sections. The first section is the “front matter,” which is the meta-information on the content. The second section contains Markdown that will be converted to HTML. +Content is stored in text files that contain two sections. The first section is the "front matter," which is the meta-information on the content. The second section contains Markdown that will be converted to HTML. #### Front Matter -The front matter is information about the content. Like the configuration file, it can be written in TOML, YAML, or JSON. Unlike the configuration file, Hugo doesn’t use the file’s extension to know the format. It looks for markers to signal the type. TOML is surrounded by “`+++`”, YAML by “`---`”, and JSON is enclosed in curly braces. I prefer to use TOML, so you’ll need to translate my examples if you prefer YAML or JSON. +The front matter is information about the content. Like the configuration file, it can be written in TOML, YAML, or JSON. Unlike the configuration file, Hugo doesn’t use the file’s extension to know the format. It looks for markers to signal the type. TOML is surrounded by "`+++`", YAML by "`---`", and JSON is enclosed in curly braces. I prefer to use TOML, so you’ll need to translate my examples if you prefer YAML or JSON. The information in the front matter is passed into the template before the content is rendered into HTML. @@ -114,49 +114,47 @@ The homepage template is a special type of list template. Hugo assumes that the #### Partial Template -A partial template is a template that can be included in other templates. Partial templates must be called using the “partial” template command. They are very handy for rolling up common behavior. For example, your site may have a banner that all pages use. Instead of copying the text of the banner into every single and list template, you could create a partial with the banner in it. That way if you decide to change the banner, you only have to change the partial template. +A partial template is a template that can be included in other templates. Partial templates must be called using the "partial" template command. They are very handy for rolling up common behavior. For example, your site may have a banner that all pages use. Instead of copying the text of the banner into every single and list template, you could create a partial with the banner in it. That way if you decide to change the banner, you only have to change the partial template. ## Create a New Site -Let's use Hugo to create a new web site. I'm a Mac user, so I'll create mine in my home directory, in the Sites folder. If you're using Linux, you might have to create the folder first. +Let's use Hugo to create a new web site. The `hugo new site` command will create a skeleton of a site. It will give you the basic directory structure and a useable configuration file. -The "new site" command will create a skeleton of a site. It will give you the basic directory structure and a useable configuration file. - -``` -$ hugo new site ~/Sites/zafta -$ cd ~/Sites/zafta -$ ls -l +```bash +$ hugo new site hugo-0.16 +$ ls -l hugo-0.16 total 8 -drwxr-xr-x 7 quoha staff 238 Sep 29 16:49 . -drwxr-xr-x 3 quoha staff 102 Sep 29 16:49 .. -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 archetypes --rw-r--r-- 1 quoha staff 82 Sep 29 16:49 config.toml -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 content -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 layouts -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 static -$ +drwxr-xr-x 2 mdhender wheel 68 Nov 27 20:27 archetypes +-rw-r--r-- 1 mdhender wheel 107 Nov 27 20:27 config.toml +drwxr-xr-x 2 mdhender wheel 68 Nov 27 20:27 content +drwxr-xr-x 2 mdhender wheel 68 Nov 27 20:27 data +drwxr-xr-x 2 mdhender wheel 68 Nov 27 20:27 layouts +drwxr-xr-x 2 mdhender wheel 68 Nov 27 20:27 static +$ ``` -Take a look in the content/ directory to confirm that it is empty. +Take a look in the `content/` directory to confirm that it is empty. -The other directories (archetypes/, layouts/, and static/) are used when customizing a theme. That's a topic for a different tutorial, so please ignore them for now. +The other directories (`archetypes/`, `data/`, `layouts/`, and `static/`) are used when customizing a named theme. That's a topic for a different tutorial, so please ignore them for now. ### Generate the HTML For the New Site Running the `hugo` command with no options will read all the available content and generate the HTML files. It will also copy all static files (that's everything that's not content). Since we have an empty site, it won't do much, but it will do it very quickly. -``` +```bash +$ cd hugo-0.16 $ hugo --verbose -INFO: 2014/09/29 Using config file: config.toml -INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/static/ to /Users/quoha/Sites/zafta/public/ -WARN: 2014/09/29 Unable to locate layout: [index.html _default/list.html _default/single.html] -WARN: 2014/09/29 Unable to locate layout: [404.html] +INFO: 2015/11/27 Using config file: /tmp/hugo-0.16/config.toml +INFO: 2015/11/27 syncing from /tmp/hugo-0.16/static/ to /tmp/hugo-0.16/public/ +WARN: 2015/11/27 Unable to locate layout for homepage: [index.html _default/list.html] +WARN: 2015/11/27 Unable to locate layout for 404 page: [404.html] 0 draft content 0 future content 0 pages created +0 paginator pages created 0 tags created 0 categories created -in 2 ms +in 4 ms $ ``` @@ -164,74 +162,78 @@ The "`--verbose`" flag gives extra information that will be helpful when we buil We can verify that the command worked by looking at the directory again. -``` +```bash $ ls -l total 8 -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 archetypes --rw-r--r-- 1 quoha staff 82 Sep 29 16:49 config.toml -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 content -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 layouts -drwxr-xr-x 4 quoha staff 136 Sep 29 17:02 public -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 static +drwxr-xr-x 2 mdhender wheel 68 Nov 27 20:27 archetypes +-rw-r--r-- 1 mdhender wheel 107 Nov 27 20:27 config.toml +drwxr-xr-x 2 mdhender wheel 68 Nov 27 20:27 content +drwxr-xr-x 2 mdhender wheel 68 Nov 27 20:27 data +drwxr-xr-x 2 mdhender wheel 68 Nov 27 20:27 layouts +drwxr-xr-x 6 mdhender wheel 204 Nov 27 20:29 public +drwxr-xr-x 2 mdhender wheel 68 Nov 27 20:27 static $ ``` -See that new public/ directory? Hugo placed all generated content there. When you're ready to publish your web site, that's the place to start. For now, though, let's just confirm that we have what we'd expect from a site with no content. +See that new `public/` directory? Hugo placed all generated content there. When you're ready to publish your web site, that's the place to start. For now, though, let's just confirm that we have what we'd expect from a site with no content. -``` -$ ls -l public +```bash +$ ls -l public/ total 16 --rw-r--r-- 1 quoha staff 416 Sep 29 17:02 index.xml --rw-r--r-- 1 quoha staff 262 Sep 29 17:02 sitemap.xml +-rw-r--r-- 1 mdhender wheel 0 Nov 27 20:29 404.html +-rw-r--r-- 1 mdhender wheel 0 Nov 27 20:29 index.html +-rw-r--r-- 1 mdhender wheel 511 Nov 27 20:29 index.xml +-rw-r--r-- 1 mdhender wheel 237 Nov 27 20:29 sitemap.xml $ ``` -Hugo created two XML files, which is standard, but there are no HTML files. +Hugo created two XML files, which is standard, and empty HTML files. The XML files are used for RSS feeds. Hugo has an opinion on what those feeds should contain, so it populates those files. Hugo has no opinion on what your web site looks like (or contains), so it leaves those files empty. +If you look back over the output from the `hugo server` command, you will 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. ### Test the New Site -Verify that you can run the built-in web server. It will dramatically shorten your development cycle if you do. Start it by running the "server" command. If it is successful, you will see output similar to the following: +Verify that you can run the built-in web server. It will dramatically shorten your development cycle if you do. Start it by running the `hugo server` command. If it is successful, you will see output similar to the following: -``` +```bash $ hugo server --verbose -INFO: 2014/09/29 Using config file: /Users/quoha/Sites/zafta/config.toml -INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/static/ to /Users/quoha/Sites/zafta/public/ -WARN: 2014/09/29 Unable to locate layout: [index.html _default/list.html _default/single.html] -WARN: 2014/09/29 Unable to locate layout: [404.html] +INFO: 2015/11/27 Using config file: /tmp/hugo-0.16/config.toml +INFO: 2015/11/27 syncing from /tmp/hugo-0.16/static/ to / +WARN: 2015/11/27 Unable to locate layout for homepage: [index.html _default/list.html] +WARN: 2015/11/27 Unable to locate layout for 404 page: [404.html] 0 draft content 0 future content 0 pages created +0 paginator pages created 0 tags created 0 categories created -in 2 ms -Serving pages from /Users/quoha/Sites/zafta/public -Web Server is available at http://localhost:1313 +in 3 ms +Watching for changes in /tmp/hugo-0.16/{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 starts with "Web Server"). If everything is working correctly, you should get a page that shows the following: - -``` -index.xml -sitemap.xml -``` - -That's a listing of your public/ directory. Hugo didn't create a home page because our site has no content. When there's no index.html file in a directory, the server lists the files in the directory, which is what you should see in your browser. +Connect to the listed URL (it's on the line that starts with `Web Server is available`.). If everything is working correctly, you should get a page that shows nothing. Let’s go back and look at those warnings again. -``` -WARN: 2014/09/29 Unable to locate layout: [index.html _default/list.html _default/single.html] -WARN: 2014/09/29 Unable to locate layout: [404.html] +```bash +WARN: 2015/11/27 Unable to locate layout for homepage: [index.html _default/list.html] +WARN: 2015/11/27 Unable to locate layout for 404 page: [404.html] ``` -That second warning is easier to explain. We haven’t created a template to be used to generate “page not found errors.” The 404 message is a topic for a separate tutorial. +That second warning is easier to explain. We haven’t created a template to be used to generate "page not found errors." The 404 message is a topic for a separate tutorial. -Now for the first warning. It is for the home page. You can tell because the first layout that it looked for was “index.html.” That’s only used by the home page. +Now for the first warning. It is for the home page. You can tell because the first layout that it looked for was `index.html`. That’s only used by the home page. -I like that the verbose flag causes Hugo to list the files that it's searching for. For the home page, they are index.html, _default/list.html, and _default/single.html. There are some rules that we'll cover later that explain the names and paths. For now, just remember that Hugo couldn't find a template for the home page and it told you so. +I like that the verbose flag causes Hugo to list the files that it's searching for. For the home page, they are `index.html` and `_default/list.html`. There are some rules that we'll cover later that explain the names and paths. For now, just remember that Hugo couldn't find a template for the home page and it told you so. At this point, you've got a working installation and site that we can build upon. All that’s left is to add some content and a theme to display it. @@ -241,83 +243,69 @@ Hugo doesn't ship with a default theme. There are a few available (I counted a d We're going to create a new theme called "zafta." Since the goal of this tutorial is to show you how to fill out the files to pull in your content, the theme will not contain any CSS. In other words, ugly but functional. -All themes have opinions on content and layout. For example, Zafta uses "post" over "blog". Strong opinions make for simpler templates but differing opinions make it tougher to use themes. When you build a theme, consider using the terms that other themes do. - +All themes have opinions on content and layout. For example, Zafta uses "article" over "blog" or "post." Strong opinions make for simpler templates but differing opinions make it tougher to use themes. When you build a theme, consider using the terms that other themes do. ### Create a Skeleton -Use the hugo "new" command to create the skeleton of a theme. This creates the directory structure and places empty files for you to fill out. +Use the `hugo new theme` command to create the skeleton of a theme. This creates the directory structure and places empty files for you to fill out. -``` +```bash $ hugo new theme zafta $ ls -l total 8 -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 archetypes --rw-r--r-- 1 quoha staff 82 Sep 29 16:49 config.toml -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 content -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 layouts -drwxr-xr-x 4 quoha staff 136 Sep 29 17:02 public -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 static -drwxr-xr-x 3 quoha staff 102 Sep 29 17:31 themes +drwxr-xr-x 2 mdhender wheel 68 Nov 27 20:27 archetypes +-rw-r--r-- 1 mdhender wheel 107 Nov 27 20:27 config.toml +drwxr-xr-x 2 mdhender wheel 68 Nov 27 20:27 content +drwxr-xr-x 2 mdhender wheel 68 Nov 27 20:27 data +drwxr-xr-x 2 mdhender wheel 68 Nov 27 20:27 layouts +drwxr-xr-x 6 mdhender wheel 204 Nov 27 20:29 public +drwxr-xr-x 2 mdhender wheel 68 Nov 27 20:27 static +drwxr-xr-x 3 mdhender wheel 102 Nov 27 20:35 themes + $ find themes -type f | xargs ls -l --rw-r--r-- 1 quoha staff 1081 Sep 29 17:31 themes/zafta/LICENSE.md --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 themes/zafta/archetypes/default.md --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 themes/zafta/layouts/_default/list.html --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 themes/zafta/layouts/_default/single.html --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 themes/zafta/layouts/index.html --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 themes/zafta/layouts/partials/footer.html --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 themes/zafta/layouts/partials/header.html --rw-r--r-- 1 quoha staff 93 Sep 29 17:31 themes/zafta/theme.toml +-rw-r--r-- 1 mdhender wheel 1081 Nov 27 20:35 themes/zafta/LICENSE.md +-rw-r--r-- 1 mdhender wheel 8 Nov 27 20:35 themes/zafta/archetypes/default.md +-rw-r--r-- 1 mdhender wheel 0 Nov 27 20:35 themes/zafta/layouts/404.html +-rw-r--r-- 1 mdhender wheel 0 Nov 27 20:35 themes/zafta/layouts/_default/list.html +-rw-r--r-- 1 mdhender wheel 0 Nov 27 20:35 themes/zafta/layouts/_default/single.html +-rw-r--r-- 1 mdhender wheel 0 Nov 27 20:35 themes/zafta/layouts/index.html +-rw-r--r-- 1 mdhender wheel 0 Nov 27 20:35 themes/zafta/layouts/partials/footer.html +-rw-r--r-- 1 mdhender wheel 0 Nov 27 20:35 themes/zafta/layouts/partials/header.html +-rw-r--r-- 1 mdhender wheel 450 Nov 27 20:35 themes/zafta/theme.toml $ ``` -The skeleton includes templates (the files ending in .html), license file, a description of your theme (the theme.toml file), and an empty archetype. +The skeleton includes templates (the files ending in `.html`), license file, a description of your theme (the `theme.toml` file), and a default archetype file. -Please take a minute to fill out the theme.toml and LICENSE.md files. They're optional, but if you're going to be distributing your theme, it tells the world who to praise (or blame). It's also nice to declare the license so that people will know how they can use the theme. - -``` -$ vi themes/zafta/theme.toml -author = "michael d henderson" -description = "a minimal working template" -license = "MIT" -name = "zafta" -source_repo = "" -tags = ["tags", "categories"] -:wq - -## also edit themes/zafta/LICENSE.md and change -## the bit that says "YOUR_NAME_HERE" -``` +When you're creating a real theme, please remember to fill out the `theme.toml` and `LICENSE.md` files. They're optional, but if you're going to be distributing your theme, it tells the world who to praise (or blame). It's also nice to declare the license so that people will know how they can use the theme. Note that the the skeleton's template files are empty. Don't worry, we'll be changing that shortly. -``` +```bash $ find themes/zafta -name '*.html' | xargs ls -l --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 themes/zafta/layouts/_default/list.html --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 themes/zafta/layouts/_default/single.html --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 themes/zafta/layouts/index.html --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 themes/zafta/layouts/partials/footer.html --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 themes/zafta/layouts/partials/header.html +-rw-r--r-- 1 mdhender wheel 0 Nov 27 20:35 themes/zafta/layouts/404.html +-rw-r--r-- 1 mdhender wheel 0 Nov 27 20:35 themes/zafta/layouts/_default/list.html +-rw-r--r-- 1 mdhender wheel 0 Nov 27 20:35 themes/zafta/layouts/_default/single.html +-rw-r--r-- 1 mdhender wheel 0 Nov 27 20:35 themes/zafta/layouts/index.html +-rw-r--r-- 1 mdhender wheel 0 Nov 27 20:35 themes/zafta/layouts/partials/footer.html +-rw-r--r-- 1 mdhender wheel 0 Nov 27 20:35 themes/zafta/layouts/partials/header.html $ ``` - - ### Update the Configuration File to Use the Theme Now that we've got a theme to work with, it's a good idea to add the theme name to the configuration file. This is optional, because you can always add "-t zafta" on all your commands. I like to put it 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, you won't use the template that you're expecting to. -Edit the file to add the theme, add a title for the site, and specify that all of our content will use the TOML format. +Edit the file to add the named theme. -``` +```bash $ vi config.toml theme = "zafta" -baseurl = "" +baseurl = "http://replace-this-with-your-hugo-site.com/" languageCode = "en-us" -title = "zafta - totally refreshing" -MetaDataFormat = "toml" +title = "My New Hugo Site" :wq $ @@ -327,59 +315,63 @@ $ Now that we have an empty theme, let's generate the site again. -``` +```bash $ hugo --verbose -INFO: 2014/09/29 Using config file: /Users/quoha/Sites/zafta/config.toml -INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/themes/zafta/static/ to /Users/quoha/Sites/zafta/public/ -INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/static/ to /Users/quoha/Sites/zafta/public/ -WARN: 2014/09/29 Unable to locate layout: [404.html theme/404.html] +INFO: 2015/11/27 Using config file: /tmp/hugo-0.16/config.toml +INFO: 2015/11/27 syncing from /tmp/hugo-0.16/themes/zafta/static to /tmp/hugo-0.16/public/ +INFO: 2015/11/27 syncing from /tmp/hugo-0.16/static/ to /tmp/hugo-0.16/public/ 0 draft content 0 future content 0 pages created +0 paginator pages created 0 tags created 0 categories created -in 2 ms +in 4 ms $ ``` -Did you notice that the output is different? The warning message for the home page has disappeared and we have an additional information line saying that Hugo is syncing from the theme's directory. +Did you notice that the output is different? The warning message for the home page has disappeared and we have an additional information line saying that Hugo is syncing from the theme's directory (`themes/zafta/`). -Let's check the public/ directory to see what Hugo's created. +Let's check the `public/` directory to see what Hugo's created. -``` +```bash $ ls -l public total 16 -drwxr-xr-x 2 quoha staff 68 Sep 29 17:56 css --rw-r--r-- 1 quoha staff 0 Sep 29 17:56 index.html --rw-r--r-- 1 quoha staff 407 Sep 29 17:56 index.xml -drwxr-xr-x 2 quoha staff 68 Sep 29 17:56 js --rw-r--r-- 1 quoha staff 243 Sep 29 17:56 sitemap.xml +-rw-r--r-- 1 mdhender wheel 0 Nov 27 20:42 404.html +drwxr-xr-x 2 mdhender wheel 68 Nov 27 20:35 css +-rw-r--r-- 1 mdhender wheel 0 Nov 27 20:42 index.html +-rw-r--r-- 1 mdhender wheel 511 Nov 27 20:42 index.xml +drwxr-xr-x 2 mdhender wheel 68 Nov 27 20:35 js +-rw-r--r-- 1 mdhender wheel 237 Nov 27 20:42 sitemap.xml $ ``` -Notice four things: +It's similar to what we had without a theme. We'd expect that since our theme has only empty templates. But notice that Hugo created `css/` and `js/` directories. That's due to our template having those in its `static/` directory: -1. Hugo created a home page. This is the file public/index.html. -2. Hugo created a css/ directory. -3. Hugo created a js/ directory. -4. Hugo claimed that it created 0 pages. It created a file and copied over static files, but didn't create any pages. That's because it considers a "page" to be a file created directly from a content file. It doesn't count things like the index.html files that it creates automatically. +```bash +$ ls -l themes/zafta/static/ +total 0 +drwxr-xr-x 2 mdhender wheel 68 Nov 27 20:35 css +drwxr-xr-x 2 mdhender wheel 68 Nov 27 20:35 js +$ +``` + +The rule with static files is simple: Hugo copies them over without any changes. #### The Home Page -Hugo supports many different types of templates. The home page is special because it gets its own type of template and its own template file. The file, layouts/index.html, is used to generate the HTML for the home page. The Hugo documentation says that this is the only required template, but that depends. Hugo's warning message shows that it looks for three different templates: +Hugo supports many different types of templates. The home page is special because it gets its own type of template and its own template file. The file `layouts/index.html` is used to generate the HTML for the home page. The Hugo documentation says that this is the only required template, but that depends. Hugo's warning message shows that it looks for two different templates: +```bash +WARN: 2015/11/27 Unable to locate layout for homepage: [index.html _default/list.html] ``` -WARN: 2014/09/29 Unable to locate layout: [index.html _default/list.html _default/single.html] -``` - -If it can't find any of these, it completely skips creating the home page. We noticed that when we built the site without having a theme installed. When Hugo created our theme, it created an empty home page template. Now, when we build the site, Hugo finds the template and uses it to generate the HTML for the home page. Since the template file is empty, the HTML file is empty, too. If the template had any rules in it, then Hugo would have used them to generate the home page. -``` +```bash $ find . -name index.html | xargs ls -l --rw-r--r-- 1 quoha staff 0 Sep 29 20:21 ./public/index.html --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 ./themes/zafta/layouts/index.html +-rw-r--r-- 1 mdhender wheel 0 Nov 27 20:42 ./public/index.html +-rw-r--r-- 1 mdhender wheel 0 Nov 27 20:35 ./themes/zafta/layouts/index.html $ ``` @@ -387,18 +379,18 @@ $ Hugo does two things when generating the site. It uses templates to transform content into HTML and it copies static files into the site. Unlike content, static files are not transformed. They are copied exactly as they are. -Hugo assumes that your site will use both CSS and JavaScript, so it creates directories in your theme to hold them. Remember opinions? Well, Hugo's opinion is that you'll store your CSS in a directory named css/ and your JavaScript in a directory named js/. If you don't like that, you can change the directory names in your theme directory or even delete them completely. Hugo's nice enough to offer its opinion, then behave nicely if you disagree. +Hugo assumes that your site will use both CSS and JavaScript, so it creates directories in your theme to hold them. Remember opinions? Well, Hugo's opinion is that you'll store your CSS in a directory named `css/` and your JavaScript in a directory named `js/`. If you don't like that, you can change the directory names in your theme's `static/` directory or even delete them completely. Hugo's nice enough to offer its opinion, then behave nicely if you disagree. -``` +```bash $ find themes/zafta -type d | xargs ls -ld -drwxr-xr-x 7 quoha staff 238 Sep 29 17:38 themes/zafta -drwxr-xr-x 3 quoha staff 102 Sep 29 17:31 themes/zafta/archetypes -drwxr-xr-x 5 quoha staff 170 Sep 29 17:31 themes/zafta/layouts -drwxr-xr-x 4 quoha staff 136 Sep 29 17:31 themes/zafta/layouts/_default -drwxr-xr-x 4 quoha staff 136 Sep 29 17:31 themes/zafta/layouts/partials -drwxr-xr-x 4 quoha staff 136 Sep 29 17:31 themes/zafta/static -drwxr-xr-x 2 quoha staff 68 Sep 29 17:31 themes/zafta/static/css -drwxr-xr-x 2 quoha staff 68 Sep 29 17:31 themes/zafta/static/js +drwxr-xr-x 7 mdhender wheel 238 Nov 27 20:35 themes/zafta +drwxr-xr-x 3 mdhender wheel 102 Nov 27 20:35 themes/zafta/archetypes +drwxr-xr-x 6 mdhender wheel 204 Nov 27 20:35 themes/zafta/layouts +drwxr-xr-x 4 mdhender wheel 136 Nov 27 20:35 themes/zafta/layouts/_default +drwxr-xr-x 4 mdhender wheel 136 Nov 27 20:35 themes/zafta/layouts/partials +drwxr-xr-x 4 mdhender wheel 136 Nov 27 20:35 themes/zafta/static +drwxr-xr-x 2 mdhender wheel 68 Nov 27 20:35 themes/zafta/static/css +drwxr-xr-x 2 mdhender wheel 68 Nov 27 20:35 themes/zafta/static/js $ ``` @@ -406,8 +398,8 @@ $ When you're working on a theme, you will make changes in the theme's directory, rebuild the site, and check your changes in the browser. Hugo makes this very easy: -1. Purge the public/ directory. -2. Run the built in web server in watch mode. +1. Purge the `public/` directory (optional, but useful if you want to start with a clean slate). +2. Run the built in web server. 3. Open your site in a browser. 4. Update the theme. 5. Glance at your browser window to see changes. @@ -419,13 +411,13 @@ Check the main Hugo site for information on using Git with Hugo. ### Purge the public/ Directory -When generating the site, Hugo will create new files and update existing ones in the ```public/``` directory. It will not delete files that are no longer used. For example, files that were created in the wrong directory or with the wrong title will remain. If you leave them, you might get confused by them later. I recommend cleaning out your site prior to generating it. +When rendering the site, Hugo will create new files and update existing ones in the `public/` directory. It will not delete files that are no longer used. For example, files that were created in the wrong directory or with the wrong title will remain. If you leave them, you might get confused by them later. Cleaning out your public files prior to rendering can help. -Note: If you're building on an SSD, you should ignore this. Churning on a SSD can be costly. +As of version 0.15, Hugo doesn't write files when running in server mode. Instead, it keeps all the rendered files in memory. You can "clean" up files by stopping and restarting the server. ### Hugo's Watch Option -Hugo's "`--watch`" option will monitor the content/ and your theme directories for changes and rebuild the site automatically. +Hugo's "`--watch`" option will monitor the content/ and your theme directories for changes and rebuild the site automatically. Since version 0.15, this has been the default option for `hugo server`. ### Live Reload @@ -435,63 +427,66 @@ Hugo's built in web server supports live reload. As pages are saved on the serve Use the following commands as the basis for your workflow. -``` -## purge old files. hugo will recreate the public directory. -## +```bash +# purge old files. hugo will recreate the public directory. +# $ rm -rf public -## -## run hugo in watch mode -## -$ hugo server --watch --verbose +# +# run hugo in watch mode with live reload +# +$ hugo server --verbose +# +# hit Control+C to kill the server when you're done +# ``` Here's sample output showing Hugo detecting a change to the template for the home page. Once generated, the web browser automatically reloaded the page. I've said this before, it's amazing. -``` -$ rm -rf public -$ hugo server --watch --verbose -INFO: 2014/09/29 Using config file: /Users/quoha/Sites/zafta/config.toml -INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/themes/zafta/static/ to /Users/quoha/Sites/zafta/public/ -INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/static/ to /Users/quoha/Sites/zafta/public/ -WARN: 2014/09/29 Unable to locate layout: [404.html theme/404.html] +```bash +$ hugo server --verbose +INFO: 2015/11/27 Using config file: /tmp/hugo-0.16/config.toml +INFO: 2015/11/27 syncing from /tmp/hugo-0.16/themes/zafta/static to / +INFO: 2015/11/27 syncing from /tmp/hugo-0.16/static/ to / 0 draft content 0 future content 0 pages created +0 paginator pages created 0 tags created 0 categories created -in 2 ms -Watching for changes in /Users/quoha/Sites/zafta/content -Serving pages from /Users/quoha/Sites/zafta/public -Web Server is available at http://localhost:1313 +in 4 ms +Watching for changes in /tmp/hugo-0.16/{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: 2014/09/29 File System Event: ["/Users/quoha/Sites/zafta/themes/zafta/layouts/index.html": MODIFY|ATTRIB] -Change detected, rebuilding site -WARN: 2014/09/29 Unable to locate layout: [404.html theme/404.html] +INFO: 2015/11/27 File System Event: ["/tmp/hugo-0.16/themes/zafta/layouts/index.html": CHMOD "/tmp/hugo-0.16/themes/zafta/layouts/index.html": WRITE] + +Change detected, rebuilding site +2015-11-27 20:57 -0600 0 draft content 0 future content 0 pages created +0 paginator pages created 0 tags created 0 categories created -in 1 ms +in 3 ms ``` ## Update the Home Page Template -The home page is one of a few special pages that Hugo creates automatically. As mentioned earlier, it looks for one of three files in the theme's layout/ directory: +The home page is one of a few special pages that Hugo creates automatically. As mentioned earlier, it looks for one of two files in the theme's `layout/` directory: -1. index.html -2. _default/list.html -3. _default/single.html +1. `index.html` +2. `_default/list.html` -We could update one of the default templates, but a good design decision is to update the most specific template available. That's not a hard and fast rule (in fact, we'll break it a few times in this tutorial), but it is a good generalization. +We could update the default templates, but a good design decision is to update the most specific template available. That's not a hard and fast rule (in fact, we'll break it a few times in this tutorial), but it is a good generalization. ### Make a Static Home Page Right now, that page is empty because we don't have any content and we don't have any logic in the template. Let's change that by adding some text to the template. -``` +```bash $ vi themes/zafta/layouts/index.html @@ -506,161 +501,149 @@ $ Build the web site and then verify the results. -``` +```bash $ hugo --verbose -INFO: 2014/09/29 Using config file: /Users/quoha/Sites/zafta/config.toml -INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/themes/zafta/static/ to /Users/quoha/Sites/zafta/public/ -INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/static/ to /Users/quoha/Sites/zafta/public/ -WARN: 2014/09/29 Unable to locate layout: [404.html theme/404.html] +INFO: 2015/11/27 Using config file: /tmp/hugo-0.16/config.toml +INFO: 2015/11/27 syncing from /tmp/hugo-0.16/themes/zafta/static to /tmp/hugo-0.16/public/ +INFO: 2015/11/27 syncing from /tmp/hugo-0.16/static/ to /tmp/hugo-0.16/public/ 0 draft content 0 future content 0 pages created +0 paginator pages created 0 tags created 0 categories created -in 2 ms +in 4 ms -$ find public -type f -name '*.html' | xargs ls -l --rw-r--r-- 1 quoha staff 78 Sep 29 21:26 public/index.html - -$ cat public/index.html +$ ls -l public/index.html +-rw-r--r-- 1 mdhender wheel 72 Nov 27 21:03 public/index.html +$ cat public/index.html
hugo says hello!
+ + +$ ``` -#### Live Reload - -Note: If you're running the server with the `--watch` option, you'll see different content in the file: - -``` -$ cat public/index.html - - - -hugo says hello!
- - -``` - -When you use `--watch`, the Live Reload script is added by Hugo. Look for live reload in the documentation to see what it does and how to disable it. - ### Build a "Dynamic" Home Page "Dynamic home page?" Hugo's a static web site generator, so this seems an odd thing to say. I mean let's have the home page automatically reflect the content in the site every time Hugo builds it. We'll use iteration in the template to do that. -#### Create New Posts +#### Create New Articles -Now that we have the home page generating static content, let's add some content to the site. We'll display these posts as a list on the home page and on their own page, too. +Now that we have the home page generating static content, let's add some content to the site. We'll display these articles as a list on the home page and on their own page, too. -Hugo has a command to generate a skeleton post, just like it does for sites and themes. +Hugo has a command to generate a skeleton entry for new content, just like it does for sites and themes. -``` -$ hugo --verbose new post/first.md -INFO: 2014/09/29 Using config file: /Users/quoha/Sites/zafta/config.toml -INFO: 2014/09/29 attempting to create post/first.md of post -INFO: 2014/09/29 curpath: /Users/quoha/Sites/zafta/themes/zafta/archetypes/default.md -ERROR: 2014/09/29 Unable to Casthugo says hello!
+ + +$ +``` + +We have to update the templates to add the articles. ### List and Single Templates @@ -668,176 +651,13 @@ In Hugo, we have three major kinds of templates. There's the home page template Generally speaking, list templates are named "list.html" and single templates are named "single.html." -There are three other types of templates: partials, content views, and terms. We will not go into much detail on these. +There are three other types of templates: partials, content views, and terms. We will give an example of some partials, but really won't go into much detail on these. ### Add Content to the Homepage -The home page will contain a list of posts. Let's update its template to add the posts that we just created. The logic in the template will run every time we build the site. +The home page will contain a list of articles. Let's update its template to add the articles that we just created. The logic in the template will run every time we build the site. -``` -$ vi themes/zafta/layouts/index.html - - - - {{ range first 10 .Data.Pages }} -my first post
- - - - -$ cat public/post/second/index.html - - - -my second post
- - - -$ -``` - -Notice that the posts now have content. You can go to localhost:1313/post/first to verify. - -### Linking to Content - -The posts are on the home page. Let's add a link from there to the post. Since this is the home page, we'll update its template. - -``` +```bash $ vi themes/zafta/layouts/index.html @@ -847,176 +667,424 @@ $ vi themes/zafta/layouts/index.html {{ end }} -``` - -Build the web site and verify the results. - -``` -$ rm -rf public -$ hugo --verbose -INFO: 2014/09/29 Using config file: /Users/quoha/Sites/zafta/config.toml -INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/themes/zafta/static/ to /Users/quoha/Sites/zafta/public/ -INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/static/ to /Users/quoha/Sites/zafta/public/ -INFO: 2014/09/29 found taxonomies: map[string]string{"tag":"tags", "category":"categories"} -WARN: 2014/09/29 Unable to locate layout: [404.html theme/404.html] -0 draft content -0 future content -2 pages created -0 tags created -0 categories created -in 4 ms - -$ find public -type f -name '*.html' | xargs ls -l --rw-r--r-- 1 quoha staff 149 Sep 29 22:44 public/index.html --rw-r--r-- 1 quoha staff 125 Sep 29 22:44 public/post/first/index.html --rw-r--r-- 1 quoha staff 0 Sep 29 22:44 public/post/index.html --rw-r--r-- 1 quoha staff 128 Sep 29 22:44 public/post/second/index.html - -$ cat public/index.html - - - - -