{"id":15287933,"url":"https://github.com/peaceiris/hugo-theme-iris","last_synced_at":"2025-04-06T09:07:33.081Z","repository":{"id":37136217,"uuid":"142685900","full_name":"peaceiris/hugo-theme-iris","owner":"peaceiris","description":"Hugo IRIS Theme - Portfolio and Blog","archived":false,"fork":false,"pushed_at":"2024-10-29T15:16:46.000Z","size":137702,"stargazers_count":70,"open_issues_count":59,"forks_count":18,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-10-29T16:03:54.019Z","etag":null,"topics":["hugo","hugo-module","hugo-theme"],"latest_commit_sha":null,"homepage":"https://hugothemeiris.peaceiris.com/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/peaceiris.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"peaceiris","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2018-07-28T14:56:18.000Z","updated_at":"2024-10-25T01:46:14.000Z","dependencies_parsed_at":"2024-04-18T09:49:37.302Z","dependency_job_id":"a47fef4e-842f-46c9-b375-6d135826a02f","html_url":"https://github.com/peaceiris/hugo-theme-iris","commit_stats":null,"previous_names":[],"tags_count":127,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peaceiris%2Fhugo-theme-iris","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peaceiris%2Fhugo-theme-iris/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peaceiris%2Fhugo-theme-iris/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peaceiris%2Fhugo-theme-iris/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/peaceiris","download_url":"https://codeload.github.com/peaceiris/hugo-theme-iris/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247457800,"owners_count":20941906,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hugo","hugo-module","hugo-theme"],"created_at":"2024-09-30T15:39:42.392Z","updated_at":"2025-04-06T09:07:33.060Z","avatar_url":"https://github.com/peaceiris.png","language":"HTML","funding_links":["https://github.com/sponsors/peaceiris"],"categories":[],"sub_categories":[],"readme":"\u003ch2 align=\"center\"\u003e\nHugo IRIS Theme\n\u003c/h2\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/peaceiris/hugo-theme-iris/main/images/tn.png\" alt=\"Hugo Iris Theme thumbnail\" width=\"500px\"\u003e\n\n[![LICENSE](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/peaceiris/hugo-theme-iris/blob/main/LICENSE)\n[![release](https://img.shields.io/github/release/peaceiris/hugo-theme-iris.svg)](https://github.com/peaceiris/hugo-theme-iris/releases/latest)\n[![release date](https://img.shields.io/github/release-date/peaceiris/hugo-theme-iris.svg)](https://github.com/peaceiris/hugo-theme-iris/releases)\n[![release feed](https://img.shields.io/badge/release-feed-yellow)](https://github.com/peaceiris/hugo-theme-iris/releases.atom)\n![deploy status](https://github.com/peaceiris/hugo-theme-iris/workflows/CI/badge.svg?branch=main\u0026event=push)\n[![hugo themes](https://img.shields.io/static/v1?label=Hugo%20Themes\u0026message=IRIS\u0026color=blueviolet)](https://themes.gohugo.io/themes/hugo-theme-iris/)\n[![lighthouse score](https://img.shields.io/static/v1?label=Lighthouse%20Score\u0026message=Good\u0026color=green)](https://hugothemeiris.peaceiris.com/report.html)\n\n\u003c/div\u003e\n\n[Go to the demo site](https://hugothemeiris.peaceiris.com/).\n\n\n\n## Table of Contents\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n\n- [Overview](#overview)\n  - [Features](#features)\n  - [Roadmap](#roadmap)\n- [Getting Started](#getting-started)\n  - [Install Hugo](#install-hugo)\n  - [Install Go](#install-go)\n  - [Install Node.js and npm](#install-nodejs-and-npm)\n  - [Initialize New Hugo Project](#initialize-new-hugo-project)\n  - [Create a Post Page](#create-a-post-page)\n  - [Create a Slide Page](#create-a-slide-page)\n- [Customize Theme](#customize-theme)\n  - [config](#config)\n  - [content](#content)\n  - [assets](#assets)\n  - [data](#data)\n  - [i18n](#i18n)\n  - [static](#static)\n- [Hosting](#hosting)\n  - [Netlify](#netlify)\n  - [GitHub Pages using Actions](#github-pages-using-actions)\n- [Shortcodes](#shortcodes)\n  - [circle](#circle)\n  - [button](#button)\n  - [mermaid](#mermaid)\n  - [repo](#repo)\n  - [github-sponsors-list](#github-sponsors-list)\n  - [table](#table)\n  - [math](#math)\n- [How to Update the Theme](#how-to-update-the-theme)\n- [Special Thanks](#special-thanks)\n- [Changelog](#changelog)\n- [Maintainer](#maintainer)\n- [Contributing](#contributing)\n- [License](#license)\n- [Development](#development)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n\n\n## Overview\n\nThis repository includes a [Hugo] theme.\n\n### Features\n\n- Dark Theme\n- Responsive\n- Support Multilingual\n- Pagination\n- SEO\n  - Google Analytics\n  - Open Graph Protocol\n  - JSON-LD\n  - Canonical URL on header\n- Performance\n  - [PageSpeed Insights Scores: Good](https://developers.google.com/speed/pagespeed/insights/?hl=EN\u0026url=https%3A%2F%2Fhugothemeiris.peaceiris.com%2F)\n  - [Lighthouse Scores: Good](https://hugothemeiris.peaceiris.com/report.html)\n- Contents\n  - Breadcrumb List\n  - Syntax Highlighting\n  - Table of Contents\n  - Random Post List\n  - [MathJax]: Beautiful math in all browsers.\n  - [mermaid]: Generation of diagram and flowchart from text in a similar manner as markdown.\n  - [reveal.js]: Writing slides using Markdown.\n- Image\n  - Responsive\n  - Eye-catching Image\n  - OGP Image\n  - WebP: requiring a Hugo extended version\n- Disqus Comment System\n- Keyboard Shortcut: Press `?` (`Shift+/`) to show help modal.\n\n### Roadmap\n\n- Share Buttons\n- Netlify, Netlify CMS\n- Categories, Tags, Authors\n- Font Awesome\n- Related posts, next and previous post\n\n\u003cdiv align=\"right\"\u003e\u003ca href=\"#table-of-contents\"\u003eBack to TOC ☝️\u003c/a\u003e\u003c/div\u003e\n\n\n\n## Getting Started\n\n### Install Hugo\n\nYou can find the minimum supported Hugo version in [theme.toml] `min_version`. Using Hugo extended version is desirable.\n\n[theme.toml]: https://github.com/peaceiris/hugo-theme-iris/blob/main/theme.toml\n\n### Install Go\n\nThis theme depends on Hugo Modules.\n\n- [Download and install - The Go Programming Language](https://golang.org/doc/install)\n\n### Install Node.js and npm\n\nThis theme depends on `node` and `npm`.\n\ncf. [Installing Node.js via package manager | Node.js](https://nodejs.org/en/download/package-manager/)\n\n### Initialize New Hugo Project\n\nHere is [the setup script](https://github.com/peaceiris/hugo-theme-iris/blob/main/scripts/setup.sh).\n\n```sh\nmkdir homepage\nwget https://raw.githubusercontent.com/peaceiris/hugo-theme-iris/main/scripts/setup.sh\nbash ./setup.sh homepage \"your_github_id\"\ncd homepage\nnpm ci\nhugo server\n```\n\n- http://localhost:1313/\n\n*Customize your site! ʕ◔ϖ◔ʔ*\n\n### Create a Post Page\n\n```sh\nhugo new posts/new.md\n```\n\n### Create a Slide Page\n\n```sh\nhugo new --kind slide posts/new-slide.md\n```\n\n\u003cdiv align=\"right\"\u003e\u003ca href=\"#table-of-contents\"\u003eBack to TOC ☝️\u003c/a\u003e\u003c/div\u003e\n\n\n\n## Customize Theme\n\nTBW.\n\n### config\n\n### content\n\n### assets\n\n### data\n\n### i18n\n\n### static\n\n\u003cdiv align=\"right\"\u003e\u003ca href=\"#table-of-contents\"\u003eBack to TOC ☝️\u003c/a\u003e\u003c/div\u003e\n\n\n\n## Hosting\n\n### Netlify\n\n\u003c!-- Deploy to Netlify Button --\u003e\n\u003c!-- https://www.netlify.com/docs/deploy-button/ --\u003e\n[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/peaceiris/hugo-theme-iris)\n\n### GitHub Pages using Actions\n\nThe following actions are useful to deploy your site to GitHub Pages using GitHub Actions.\n\n- [peaceiris/actions-hugo: GitHub Actions for Hugo](https://github.com/peaceiris/actions-hugo)\n- [peaceiris/actions-gh-pages: GitHub Actions for GitHub Pages](https://github.com/peaceiris/actions-gh-pages)\n\n\u003cdiv align=\"right\"\u003e\u003ca href=\"#table-of-contents\"\u003eBack to TOC ☝️\u003c/a\u003e\u003c/div\u003e\n\n\n\n## Shortcodes\n\n### circle\n\nIf your logo image is located at `assets/images/logo.jpg`.\n\n```md\n{{\u003c circle src=\"images/logo.jpg\" alt=\"hugo-theme-iris logo\" \u003e}}\n```\n\n\u003cimg width=\"500px\" src=\"https://raw.githubusercontent.com/peaceiris/hugo-theme-iris/main/exampleSite/assets/images/shortcode_circle.jpg\" alt=\"Shortcode mermaid\"\u003e\n\n### button\n\n```md\n\u003cdiv class=\"buttons\"\u003e\n  {{\u003c button href=\"https://gohugo.io/\" txt=\"Hugo Homepage\" \u003e}}\n  {{\u003c button href=\"https://github.com/gohugoio/\" txt=\"Hugo GitHub\" \u003e}}\n  {{\u003c button href=\"https://discourse.gohugo.io/\" txt=\"Hugo Forum\" \u003e}}\n  {{\u003c button href=\"https://twitter.com/GoHugoIO\" txt=\"Hugo Twitter\" \u003e}}\n\u003c/div\u003e\n```\n\n\u003cimg width=\"500px\" src=\"https://raw.githubusercontent.com/peaceiris/hugo-theme-iris/main/exampleSite/assets/images/shortcode_button.jpg\" alt=\"Shortcode button\"\u003e\n\n### mermaid\n\n```md\n{{\u003c mermaid \u003e}}\nsequenceDiagram\n  participant Alice\n  participant Bob\n  Alice-\u003e\u003eJohn: Hello John, how are you?\n  loop Healthcheck\n    John-\u003e\u003eJohn: Fight against hypochondria\n  end\n  Note right of John: Rational thoughts \u003cbr/\u003eprevail!\n  John--\u003e\u003eAlice: Great!\n  John-\u003e\u003eBob: How about you?\n  Bob--\u003e\u003eJohn: Jolly good!\n{{\u003c /mermaid \u003e}}\n```\n\n\u003cimg width=\"500px\" src=\"https://raw.githubusercontent.com/peaceiris/hugo-theme-iris/main/exampleSite/assets/images/shortcode_mermaid.jpg\" alt=\"Shortcode mermaid\"\u003e\n\n### repo\n\nRun the following script to get the latest repository data.\nThe script requires the [gh] command.\n\n[gh]: https://github.com/cli/cli\n\nFor more details: [scripts/fetch_data.sh](https://github.com/peaceiris/hugo-theme-iris/blob/main/exampleSite/scripts/fetch_data.sh)\n\n```sh\nbrew install gh\ngh auth login\n```\n\n```sh\ncd ./your_hugo_project\nexport GH_USER_ID=\"peaceiris\"\nbash ./scripts/fetch_data.sh \"${GH_USER_ID}\" \u003e \"./data/github/${GH_USER_ID}.json\"\n```\n\nWe can show a repository card like as follows.\n\n```md\n{{\u003c repo id=\"peaceiris\" name=\"actions-gh-pages\" \u003e}}\n\n{{\u003c repo id=\"peaceiris\" name=\"actions-hugo\" \u003e}}\n```\n\n\u003cimg width=\"500px\" src=\"https://raw.githubusercontent.com/peaceiris/hugo-theme-iris/main/exampleSite/assets/images/shortcode_repo.jpg\" alt=\"Shortcode repo\"\u003e\n\n### github-sponsors-list\n\nPlease follow the instruction as the same as the `repo` shortcode.\n\n```md\n{{\u003c github-sponsors-list id=\"peaceiris\" \u003e}}\n```\n\n\u003cimg width=\"500px\" src=\"https://raw.githubusercontent.com/peaceiris/hugo-theme-iris/main/exampleSite/assets/images/shortcode_github-sponsors-list.jpg\" alt=\"Shortcode github-sponsors-list\"\u003e\n\n### table\n\n```md\n{{\u003c table \u003e}}\n| Key | Value |\n|---|---|\n| Static Site Generator | Hugo |\n| Language | Go |\n{{\u003c /table \u003e}}\n```\n\n| Mouse out | Mouse over |\n|---|---|\n| ![Shortcode table mouse out](https://raw.githubusercontent.com/peaceiris/hugo-theme-iris/main/exampleSite/assets/images/shortcode_table_1.jpg) | ![Shortcode table mouse over](https://raw.githubusercontent.com/peaceiris/hugo-theme-iris/main/exampleSite/assets/images/shortcode_table_2.jpg) |\n\n### math\n\nSee also [the example page](https://hugothemeiris.peaceiris.com/posts/math/).\n\nWhen you use the ampersand sign `\u0026`, you need to use the following math shortcode.\n\n```md\n{{\u003c math \u003e}}\n\\begin{vmatrix}a \u0026 b\\\\\nc \u0026 d\n\\end{vmatrix}\n{{\u003c /math \u003e}}\n```\n\n\u003cdiv align=\"right\"\u003e\u003ca href=\"#table-of-contents\"\u003eBack to TOC ☝️\u003c/a\u003e\u003c/div\u003e\n\n\n\n## How to Update the Theme\n\n```sh\ncd your_hugo_project\nhugo mod get -u hugo mod get -u github.com/peaceiris/hugo-theme-iris\nhugo mod tidy \u0026\u0026 hugo mod verify\ngit add go.mod go.sum\ngit commit -m \"deps: bump hugo-theme-iris\"\n```\n\n\u003cdiv align=\"right\"\u003e\u003ca href=\"#table-of-contents\"\u003eBack to TOC ☝️\u003c/a\u003e\u003c/div\u003e\n\n\n\n## Special Thanks\n\n- [Hugo]\n- [Bulma]\n- [reveal.js]\n- [MathJax]\n- [mermaid]\n- [jaywcjlove/hotkeys](https://github.com/jaywcjlove/hotkeys)\n\n\u003c!-- - Font Awesome --\u003e\n\n\u003cdiv align=\"right\"\u003e\u003ca href=\"#table-of-contents\"\u003eBack to TOC ☝️\u003c/a\u003e\u003c/div\u003e\n\n\n\n## Changelog\n\n- [hugo-theme-iris/CHANGELOG.md](https://github.com/peaceiris/hugo-theme-iris/blob/main/CHANGELOG.md)\n\n\n\n## Maintainer\n\n- [peaceiris homepage](https://peaceiris.com)\n\n\n\n## Contributing\n\nTo contribute to this Hugo theme.\n\nYou can find more detail in our [Contributing Guide].\n\n\n\n## License\n\n- [MIT License - peaceiris/hugo-theme-iris](https://github.com/peaceiris/hugo-theme-iris/blob/main/LICENSE)\n\n\n\n## Development\n\n```sh\n{{ partial \"console-log\" $hoge }}\n```\n\n---\n\n\u003cdiv align=\"right\"\u003e\u003ca href=\"#table-of-contents\"\u003eBack to TOC ☝️\u003c/a\u003e\u003c/div\u003e\n\n\n\n\u003c!-- Internal References --\u003e\n[Contributing Guide]: https://github.com/peaceiris/hugo-theme-iris/blob/main/CONTRIBUTING.md\n\n\u003c!-- External References --\u003e\n[Hugo]: https://gohugo.io/\n[Bulma]: https://bulma.io/\n[reveal.js]: https://github.com/hakimel/reveal.js/\n[MathJax]: https://www.mathjax.org/\n[mermaid]: https://github.com/knsv/mermaid\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeaceiris%2Fhugo-theme-iris","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeaceiris%2Fhugo-theme-iris","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeaceiris%2Fhugo-theme-iris/lists"}