Repository: varkai/hugo-theme-zozo Branch: master Commit: f16ebe56f030 Files: 35 Total size: 97.2 KB Directory structure: gitextract_c6uelrdi/ ├── .github/ │ └── workflows/ │ └── main.yml ├── .gitignore ├── LICENSE ├── README-zh.md ├── README.md ├── archetypes/ │ └── default.md ├── exampleSite/ │ ├── config.toml │ ├── content/ │ │ ├── about/ │ │ │ └── index.md │ │ └── posts/ │ │ ├── chinese-preview.md │ │ ├── english-preview.md │ │ ├── japanese-preview.md │ │ └── theme-preview.md │ └── netlify.toml ├── i18n/ │ ├── en.yaml │ └── zh-cn.yaml ├── layouts/ │ ├── 404.html │ ├── _default/ │ │ ├── list.html │ │ ├── single.html │ │ └── terms.html │ ├── index.html │ ├── partials/ │ │ ├── comments.html │ │ ├── footer.html │ │ ├── head.html │ │ ├── header.html │ │ ├── js.html │ │ ├── mathjax.html │ │ ├── nav.html │ │ └── post.html │ └── shortcodes/ │ └── img.html ├── static/ │ ├── css/ │ │ ├── comments.css │ │ ├── highlight.css │ │ ├── normalize.css │ │ └── zozo.css │ └── js/ │ └── zozo.js └── theme.toml ================================================ FILE CONTENTS ================================================ ================================================ FILE: .github/workflows/main.yml ================================================ name: ci on: schedule: - cron: "*/60 * * * *" jobs: autogreen: runs-on: ubuntu-latest steps: - name: Clone repository uses: actions/checkout@v3 - name: Auto green run: | git config --local user.email "zk@varkai.com" git config --local user.name "varkai" git remote set-url origin https://${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }} git pull --rebase git commit --allow-empty -m "a commit a day keeps your girlfriend away" git push ================================================ FILE: .gitignore ================================================ # Hugo default output directory /public ## OS Files # Windows Thumbs.db Desktop.ini $RECYCLE.BIN/ # OSX .DS_Store *.map ================================================ FILE: LICENSE ================================================ The MIT License (MIT) Copyright (c) 2019 varkai Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ================================================ FILE: README-zh.md ================================================ # Hugo Theme Zozo [](https://github.com/varkai/hugo-theme-zozo/blob/master/LICENSE) > 该主题移植自 [Aragaki](https://github.com/PCDotFan/Aragaki),结构样式参考自 [菩提树下](https://blog.caicai.me/),部分功能参考自 [Even](https://github.com/olOwOlo/hugo-theme-even) **在线预览**:[Demo](https://zozo.varkai.com) ## 截图  ## 安装 首先进入 hugo 的站点目录运行下面的命令: ```bash $ git clone https://github.com/varkai/hugo-theme-zozo themes/zozo ``` 本主题提供了一个示例配置文件是 [`exampleSite`](./exampleSite) 目录里的 [`config.toml`](./exampleSite/config.toml) 文件。 配置文件中对大部分配置都有详细的注释说明,复制该文件到站点目录下,根据自己的情况修改即可。 更多安装信息查看 Hugo 官方文档 [setup guide](https://gohugo.io/overview/installing/)。 ## 示例站点 `exampleSite` 是本主题的一个示例站点,里面有配置文件、关于页面的一些示例。 ## 关于页面 使用关于页面,首先要在你的站点目录的 [`content`](./exampleSite/content/) 目录下创建一个 [`about`](./exampleSite/content/about/) 目录,然后再创建一个 [`index.md`](./exampleSite/content/about/index.md) 文件,最后编写该文件即可。 ## Shortcodes 主题提供了 `img` shortcode. ```markdown {{< img src="path/to/xxx.png" >}} ``` ## Math 公式 本主题支持 MathJax 数学公式,默认为关闭状态,如需使用,需要在 [`config.toml`](./exampleSite/config.toml) 中进行设置。 设置 `[params]` 下的 `mathjax = true` 来支持数学公式。 ## Valine 评论 本主题提供了 Valine 评论系统,默认为关闭状态,如需使用,需要在 [`config.toml`](./exampleSite/config.toml) 中进行设置。 设置 `[params.valine]` 下的 `enable = true` 来开启评论系统,并将 `appId` 和 `appKey` 设置为你自己的。 ## 社交链接 本主题的社交链接是字体图标的样式,并放置在了页面头部。你可以通过在 [`config.toml`](./exampleSite/config.toml) 的 `[social]` 模块中修改添加你的社交链接。 ## 部署主题 配置完成之后,就可以使用下面的命令来启动 hugo 服务编译 markdown 文件生成静态站点: ```bash $ hugo server ``` 然后在浏览器地址栏输入 [localhost:1313](http://localhost:1313) 来访问站点。 ## License Released under the [MIT](https://github.com/varkai/hugo-theme-zozo/blob/master/LICENSE) License. ## 致谢 - [Aragaki](https://github.com/PCDotFan/Aragaki) - [菩提树下](https://blog.caicai.me/) - [olOwOlo](https://olowolo.com/) ================================================ FILE: README.md ================================================ # Hugo Theme Zozo [](https://github.com/varkai/hugo-theme-zozo/blob/master/LICENSE) A simple and beautiful theme for Hugo > It's a port of [Aragaki](https://github.com/PCDotFan/Aragaki), The style is reference from [菩提树下](https://blog.caicai.me/), Some functions are referenced from [Even](https://github.com/olOwOlo/hugo-theme-even) **Features** + **Responsive** + **Syntax highlighting with highlightjs** + **Math with mathjax** + **Social links(Customize)** + **Tags page** + **Archive page** + **Disqus and [Valine](https://valine.js.org/en/index.html) comment-system** + **Fancybox** + **GoogleAnalytics** [Demo](https://zozo.varkai.com) | [中文说明](./README-zh.md) ## Sceenshots  ## Installation ```bash $ git clone https://github.com/varkai/hugo-theme-zozo themes/zozo ``` **Important**: Take a look inside the [`exampleSite`](./exampleSite) folder of this theme. You'll find a file called [`config.toml`](./exampleSite/config.toml). To use it, copy the [`config.toml`](./exampleSite/config.toml) in the root folder of your Hugo site. Feel free to change it. ## ExampleSite There is an example site with config file and markdown files in `exampleSite` directory. ## About Page Use the about page to introduce yourself to your visitors. You can customize the content as you like in the `/content/about/index.md`. ## Shortcodes This theme provides `img` shortcodes. ```markdown {{< img src="path/to/xxx.png" >}} ``` ## MathJax This theme supports MathJax, which are turned off by default. If you want to use them, you need to set them in `config.toml`. Set `mathjax = true` under the `[params]` to support the MathJax. ## Valine Comment System This theme provides valine comment system, the default is closed, if you want to use, need to set in `config. toml`. Set the `enable = true` under `[params.valine]` to open valine, and will be `appId` and `appKey` set for yourself. ## Social Link Icons You can add a social link panel in the header by adding entries to the social block in the `config.toml`. [Remix icon](https://remixicon.com/) is used in this theme. ## Nearly Finished In order to see your site in action, run Hugo's built-in local server. ```bash $ hugo server ``` Now enter `localhost:1313` in the address bar of your browser. ## License Released under the [MIT](https://github.com/varkai/hugo-theme-zozo/blob/master/LICENSE) License. ## Acknowledgements - [Aragaki](https://github.com/PCDotFan/Aragaki) - [菩提树下](https://blog.caicai.me/) - [olOwOlo](https://olowolo.com/) ================================================ FILE: archetypes/default.md ================================================ --- title: "{{ replace .Name "-" " " | title }}" date: {{ .Date }} hidden: false draft: true tags: [] keywords: [] description: "" slug: "" --- ================================================ FILE: exampleSite/config.toml ================================================ baseURL = "http://localhost:1313/" languageCode = "en" defaultContentLanguage = "en" title = "ZO ZO" # site title # 网站标题 theme = "zozo" hasCJKLanguage = true # has chinese/japanese/korean ? # 自动检测是否包含 中文\日文\韩文 summaryLength = 100 paginate = 4 # shows the number of articles # 首页显示文章数量 enableEmoji = true googleAnalytics = "" # your google analytics id # Google统计代码 disqusShortname = "" # your discuss shortname # Disqus评论系统代码 pygmentsUseClasses = true pygmentCodeFences = true pygmentscodefencesguesssyntax = true [author] # essential # 必需 name = "VarKai" [blackfriday] smartypants = false [[menu.main]] # config your menu # 配置菜单 name = "Home" weight = 10 identifier = "home" url = "/" [[menu.main]] name = "Archive" weight = 20 identifier = "archive" url = "/posts/" [[menu.main]] name = "Tags" weight = 30 identifier = "tags" url = "/tags/" [[menu.main]] name = "About" weight = 40 identifier = "about" url = "/about/" [params] subTitle = "the site subtitle" # site's subTitle # 网站二级标题 footerSlogan = "My spiritual home" # site's footer slogan # 网站页脚标语 keywords = ["Hugo","theme","zozo"] # site's keywords # 网站关键字 description = "Hugo theme zozo example site." # site's description # 网站描述 enableMathJax = true # enable mathjax # 是否使用mathjax(数学公式) enableSummary = true # display the article summary # 是否显示文章摘要 mainSections = ["posts","post"] # Valine. # You can get your appid and appkey from https://leancloud.cn # more info please open https://valine.js.org [params.valine] enable = false appId = "" appKey = "" placeholder = " " visitor = true # Your socail's url # 社交地址配置 [social] github = " " twitter = " " facebook = " " weibo = " " instagram = " " [markup] [markup.goldmark] [markup.goldmark.renderer] unsafe = true ================================================ FILE: exampleSite/content/about/index.md ================================================ --- title: "关于" date: 2018-12-29T20:24:28+08:00 hidden: true draft: false --- Hugo 官方主页: [https://gohugo.io/](https://gohugo.io/) Hugo的安装方式有两种,一种是直接下载编译好的Hugo二进制文件。如果只是使用Hugo推荐用这种方式。另一种方式是获取Hugo的源码,自己编译。由于各种不可预料的网络问题,第二种方式不是那么轻易能成功,虽然最后我还是折腾出来了。 Hugo二进制下载地址: [https://github.com/gohugoio/hugo/releases](https://github.com/gohugoio/hugo/releases) ================================================ FILE: exampleSite/content/posts/chinese-preview.md ================================================ --- title: "药师灌顶真言" date: 2019-04-11T14:26:00+08:00 draft: false tags: ["中文", "真言"] slug: "Chinese-Preview" --- > 修学药师灌顶真言是药师法门的一部分,读诵修持有着极大的功德利益 # 内容 南无薄伽伐帝鞞杀社 窭噜薜琉璃 跋喇婆 喝啰阇也 怛他揭多也 阿啰喝帝 三藐三勃陀耶 怛侄他 唵 鞞刹逝 鞞刹逝 鞞刹社 三没揭帝莎诃 # 读法 那摩波切罚地 皮杀社 句度比琉璃 波拉婆 和拉舌也 大拖接多也 艾拉和地 三秒三波拖也 大至拖 安 皮杀逝 皮杀逝 皮杀社 三摩接地缩和 # 简单释义 南无 薄伽伐帝 归命 世尊 鞞杀社 窭噜 薜琉璃 跋喇婆 喝啰阇也 药 师 琉璃 光 王 怛他揭多也 阿啰喝帝 三藐三勃陀耶 如来 应供 正等正觉 怛侄他 即说咒曰 唵 鞞刹逝 鞞刹逝 鞞刹社 三没揭帝 唵 药 药 药师 自度度他 莎诃 成就 ================================================ FILE: exampleSite/content/posts/english-preview.md ================================================ --- title: "Creating a New Theme" date: 2019-04-01T14:26:00+08:00 draft: false tags: ["English", "Theme"] slug: "English Preview" --- ## Introduction 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. 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 $ echo this is a command this is a command ## edit the file $vi foo.md +++ date = "2014-09-28" title = "creating a new theme" +++ bah and humbug :wq ## show it $ cat foo.md +++ date = "2014-09-28" title = "creating a new theme" +++ bah and humbug $ ``` ## Some Definitions There are a few concepts that you need to understand before creating a theme. ### Skins 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. 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 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. ### 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. ### 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. ### 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. #### 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 information in the front matter is passed into the template before the content is rendered into HTML. #### Markdown Content is written in Markdown which makes it easier to create the content. Hugo runs the content through a Markdown engine to create the HTML which will be written to the output file. ### Template Files Hugo uses template files to render content into HTML. Template files are a bridge between the content and presentation. Rules in the template define what content is published, where it's published to, and how it will rendered to the HTML file. The template guides the presentation by specifying the style to use. There are three types of templates: single, list, and partial. Each type takes a bit of content as input and transforms it based on the commands in the template. Hugo uses its knowledge of the content to find the template file used to render the content. If it can’t find a template that is an exact match for the content, it will shift up a level and search from there. It will continue to do so until it finds a matching template or runs out of templates to try. If it can’t find a template, it will use the default template for the site. Please note that you can use the front matter to influence Hugo’s choice of templates. #### Single Template A single template is used to render a single piece of content. For example, an article or post would be a single piece of content and use a single template. #### List Template A list template renders a group of related content. That could be a summary of recent postings or all articles in a category. List templates can contain multiple groups. The homepage template is a special type of list template. Hugo assumes that the home page of your site will act as the portal for the rest of the content in the site. #### 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. 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 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 $ ``` 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. ### 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. ``` $ 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] 0 draft content 0 future content 0 pages created 0 tags created 0 categories created in 2 ms $ ``` The "`--verbose`" flag gives extra information that will be helpful when we build the template. Every line of the output that starts 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. ``` $ 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 $ ``` 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 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 $ ``` Hugo created two XML files, which is standard, but there are no HTML files. ### 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: ``` $ 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] 0 draft content 0 future content 0 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 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. 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] ``` 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. 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. 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. ## Create a New Theme Hugo doesn't ship with a default theme. There are a few available (I counted a dozen when I first installed Hugo) and Hugo comes with a command to create new themes. 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. ### 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. ``` $ 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 $ 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 $ ``` The skeleton includes templates (the files ending in .html), license file, a description of your theme (the theme.toml file), and an empty archetype. 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" ``` Note that the the skeleton's template files are empty. Don't worry, we'll be changing that shortly. ``` $ 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 $ ``` ### 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. ``` $ vi config.toml theme = "zafta" baseurl = "" languageCode = "en-us" title = "zafta - totally refreshing" MetaDataFormat = "toml" :wq $ ``` ### Generate the Site Now that we have an empty theme, let's generate the site again. ``` $ 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] 0 draft content 0 future content 0 pages created 0 tags created 0 categories created in 2 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. Let's check the public/ directory to see what Hugo's created. ``` $ 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 $ ``` Notice four things: 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. #### 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: ``` 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. ``` $ 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 $ ``` #### The Magic of Static 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. ``` $ 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 $ ``` ## The Theme Development Cycle 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. 3. Open your site in a browser. 4. Update the theme. 5. Glance at your browser window to see changes. 6. Return to step 4. I’ll throw in one more opinion: never work on a theme on a live site. Always work on a copy of your site. Make changes to your theme, test them, then copy them up to your site. For added safety, use a tool like Git to keep a revision history of your content and your theme. Believe me when I say that it is too easy to lose both your mind and your changes. 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. Note: If you're building on an SSD, you should ignore this. Churning on a SSD can be costly. ### Hugo's Watch Option Hugo's "`--watch`" option will monitor the content/ and your theme directories for changes and rebuild the site automatically. ### Live Reload Hugo's built in web server supports live reload. As pages are saved on the server, the browser is told to refresh the page. Usually, this happens faster than you can say, "Wow, that's totally amazing." ### Development Commands Use the following commands as the basis for your workflow. ``` ## purge old files. hugo will recreate the public directory. ## $ rm -rf public ## ## run hugo in watch mode ## $ hugo server --watch --verbose ``` 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] 0 draft content 0 future content 0 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 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] 0 draft content 0 future content 0 pages created 0 tags created 0 categories created in 1 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: 1. index.html 2. _default/list.html 3. _default/single.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. ### 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. ``` $ vi themes/zafta/layouts/index.html
hugo says hello!
:wq $ ``` Build the web site and then verify the results. ``` $ 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] 0 draft content 0 future content 0 pages created 0 tags created 0 categories created in 2 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.htmlhugo 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.htmlhugo 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 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. Hugo has a command to generate a skeleton post, 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 Castmy first post
$ cat public/post/second/index.htmlmy 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. ``` $ vi themes/zafta/layouts/index.html {{ range first 10 .Data.Pages }}