Hugo IRIS Theme

Table of Contents

• Overview
  • Features
  • Roadmap
• Getting Started
  • Get Hugo
  • Initialize New Hugo Project
• Hugo Modules
• Hosting
  • Netlify
  • GitHub Pages using Actions
• Shortcodes
  • button
  • li
  • mermaid
  • repo
  • table
• Special Thanks
• Changelog
• Maintainer
• Contributing
• License

Overview

This repository includes the Hugo theme.

• Demo site on GitHub Pages

Features

• Dark Theme
• Responsive
• Support Multilingual
• PageSpeed Insights Scores: Good
• Lighthouse Scores: Good
• Breadcrumb List
• Syntax Highlighting
• Eye-catching Image
• Disqus Comment System
• Google Analytics
• Open Graph Protocol, OGP Images
• Table of Contents
• MathJax: Beautiful math in all browsers.
• mermaid: Generation of diagram and flowchart from text in a similar manner as markdown.
• reveal.js: Writing slides using Markdown.

Roadmap

• Share Buttons
• JSON-LD
• Netlify, Netlify CMS
• Categories, Tags, Authors
• Font Awesome
• Related posts, next and previous post

Getting Started

Get Hugo

You can find the minimum supported Hugo version in theme.toml min_version. Using Hugo extended version is desirable.

Initialize New Hugo Project

mkdir ./homepage && cd ./homepage
git init
git submodule add https://github.com/peaceiris/hugo-theme-iris.git ./themes/hugo-theme-iris
cd ./themes/hugo-theme-iris
git checkout vx.x.x
cd ../..
git commit "Add theme"
cp -r ./themes/hugo-theme-iris/exampleSite/{assets,config,content,data,i18n,static} .
vim ./config/_default/config.yaml  # uncomment 'theme: hugo-theme-iris'
hugo server

• http://localhost:1313/

Customize your site! ʕ◔ϖ◔ʔ

Hugo Modules

Get and Update.

hugo mod get -u github.com/peaceiris/hugo-theme-iris

config/_default/config.yaml

module:
  imports:
    - path: github.com/peaceiris/hugo-theme-iris

Hosting

Netlify

GitHub Pages using Actions

The following actions are useful to deploy your site to GitHub Pages using GitHub Actions.

• peaceiris/actions-hugo: GitHub Actions for Hugo
• peaceiris/actions-gh-pages: GitHub Actions for GitHub Pages

Shortcodes

button

<div class="buttons">
  {{< button href="https://gohugo.io/" txt="Hugo Homepage" >}}
  {{< button href="https://github.com/gohugoio/" txt="Hugo GitHub" >}}
  {{< button href="https://discourse.gohugo.io/" txt="Hugo Forum" >}}
  {{< button href="https://twitter.com/GoHugoIO" txt="Hugo Twitter" >}}
</div>

li

{{< li >}}
- Hugo
- Golang
- Static Site Generators
{{< /li >}}

{{< li >}}
1. Hugo
1. Golang
1. Static Site Generators
{{< /li >}}

mermaid

{{< mermaid >}}
sequenceDiagram
  participant Alice
  participant Bob
  Alice->>John: Hello John, how are you?
  loop Healthcheck
    John->>John: Fight against hypochondria
  end
  Note right of John: Rational thoughts <br/>prevail!
  John-->>Alice: Great!
  John->>Bob: How about you?
  Bob-->>John: Jolly good!
{{< /mermaid >}}

repo

{{< repo id="peaceiris" name="actions-gh-pages" >}}

{{< repo id="peaceiris" name="actions-hugo" >}}

table

{{< table >}}
| Key | Value |
|---|---|
| Static Site Generator | Hugo |
| Language | Go |
{{< /table >}}

Mouse out	Mouse over

Special Thanks

• Hugo
• Bulma

Changelog

• hugo-theme-iris/CHANGELOG.md

Maintainer

• peaceiris homepage

Contributing

To contribute to this Hugo theme.

You can find more detail in our Contributing Guide.

License

• MIT License - peaceiris/hugo-theme-iris

---

Back to TOC ☝️