├── go.sum ├── .nvmrc ├── exampleSite ├── go.sum ├── .hugo_build.lock ├── static │ ├── .nojekyll │ ├── CNAME │ ├── images │ │ ├── ogp.jpg │ │ └── brand.svg │ ├── favicon │ │ ├── favicon64.ico │ │ ├── ms-icon-150x150.jpg │ │ └── apple-icon-180x180.jpg │ ├── _redirects │ └── admin │ │ ├── index.html │ │ └── config.yml ├── data │ └── github │ │ ├── .json │ │ └── peaceiris.json ├── config │ ├── production │ │ ├── config.yaml │ │ └── params.yaml │ ├── staging │ │ ├── config.yaml │ │ └── params.yaml │ ├── development │ │ └── params.yaml │ └── _default │ │ ├── params.yaml │ │ ├── menus │ │ ├── menus.ja.yaml │ │ └── menus.en.yaml │ │ └── config.yaml ├── assets │ └── images │ │ ├── logo.jpg │ │ ├── screenshot.jpg │ │ ├── shortcode_button.jpg │ │ ├── shortcode_circle.jpg │ │ ├── shortcode_repo.jpg │ │ ├── shortcode_mermaid.jpg │ │ ├── shortcode_table_1.jpg │ │ ├── shortcode_table_2.jpg │ │ ├── .gitignore │ │ └── shortcode_github-sponsors-list.jpg ├── .gitignore ├── content │ ├── en │ │ ├── posts │ │ │ ├── _index.md │ │ │ ├── github-pages-and-github-actions.md │ │ │ ├── math.md │ │ │ ├── rich-content.md │ │ │ ├── mermaid.md │ │ │ ├── emoji-support.md │ │ │ ├── revealjs.md │ │ │ └── markdown-syntax.md │ │ └── _index.md │ └── ja │ │ ├── posts │ │ ├── _index.md │ │ └── github-pages-and-github-actions.md │ │ └── _index.md ├── go.mod ├── i18n │ ├── ja.yaml │ └── en.yaml ├── package.json └── scripts │ ├── fetch_data.sh │ └── fetch_images.ts ├── layouts ├── 404.html ├── shortcodes │ ├── math.html │ ├── mermaid.html │ ├── button.html │ ├── centered.html │ ├── table.html │ ├── code.html │ ├── github-sponsors-list.html │ ├── repo.html │ └── circle.html ├── robots.txt ├── partials │ ├── console-log.html │ ├── badges │ │ ├── draft.html │ │ ├── slide.html │ │ ├── canonical.html │ │ └── badges.html │ ├── toc.html │ ├── edit-button.html │ ├── canonical-link.html │ ├── view-on-github-button.html │ ├── mathjax.html │ ├── head │ │ ├── favicon.html │ │ ├── json-ld.html │ │ ├── ogp.html │ │ └── general.html │ ├── mermaid.html │ ├── content.html │ ├── breadcrumb.html │ ├── footer.html │ ├── random-post-list.html │ ├── head.html │ ├── lang-button.html │ ├── revealjs │ │ └── js.html │ ├── share-buttons.html │ ├── check-tools.html │ ├── eyecatch.html │ ├── keyboard-shortcut.html │ └── header.html ├── index.html └── _default │ ├── _markup │ ├── render-heading.html │ ├── render-link.html │ └── render-image.html │ ├── single.html │ ├── baseof.html │ └── list.html ├── .go-version ├── .dockerignore ├── .husky ├── pre-commit └── post-merge ├── assets └── theme │ ├── scss │ ├── style.scss │ └── bulma.scss │ └── css │ └── syntax.css ├── .envrc ├── go.mod ├── .gitignore ├── hugo.yaml ├── images ├── tn.png └── screenshot.png ├── deps ├── main.go └── go.mod ├── archetypes ├── slide.md └── default.md ├── .editorconfig ├── .github ├── labeler.yml ├── dependabot.yaml ├── ISSUE_TEMPLATE │ ├── config.yml │ ├── feature_request.md │ └── bug_report.md ├── workflows │ ├── labeler.yml │ ├── label-commenter.yml │ ├── dependency-review.yml │ ├── release.yml │ └── ci.yml ├── release.yml └── label-commenter-config.yml ├── docker-compose.yml ├── renovate.json ├── scripts └── setup.sh ├── theme.toml ├── LICENSE ├── package.json ├── CONTRIBUTING.md ├── .devcontainer └── devcontainer.json ├── Makefile └── README.md /go.sum: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.nvmrc: -------------------------------------------------------------------------------- 1 | 20.19.5 2 | -------------------------------------------------------------------------------- /exampleSite/go.sum: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /layouts/404.html: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.go-version: -------------------------------------------------------------------------------- 1 | 1.22.3 2 | -------------------------------------------------------------------------------- /.dockerignore: -------------------------------------------------------------------------------- 1 | .* 2 | * 3 | -------------------------------------------------------------------------------- /exampleSite/.hugo_build.lock: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /exampleSite/static/.nojekyll: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /exampleSite/data/github/.json: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.husky/pre-commit: -------------------------------------------------------------------------------- 1 | npx lint-staged 2 | -------------------------------------------------------------------------------- /assets/theme/scss/style.scss: -------------------------------------------------------------------------------- 1 | // custom style 2 | -------------------------------------------------------------------------------- /.husky/post-merge: -------------------------------------------------------------------------------- 1 | npm ci 2 | git remote prune origin 3 | -------------------------------------------------------------------------------- /exampleSite/static/CNAME: -------------------------------------------------------------------------------- 1 | hugothemeiris.peaceiris.com 2 | -------------------------------------------------------------------------------- /.envrc: -------------------------------------------------------------------------------- 1 | nvmrc=~/.nvm/nvm.sh 2 | source $nvmrc 3 | nvm use 4 | -------------------------------------------------------------------------------- /layouts/shortcodes/math.html: -------------------------------------------------------------------------------- 1 | $$ 2 | {{ .Inner }} 3 | $$ 4 | -------------------------------------------------------------------------------- /exampleSite/config/production/config.yaml: -------------------------------------------------------------------------------- 1 | # Config for production 2 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/peaceiris/hugo-theme-iris 2 | 3 | go 1.18 4 | -------------------------------------------------------------------------------- /exampleSite/config/production/params.yaml: -------------------------------------------------------------------------------- 1 | # Params for production (build mode) 2 | -------------------------------------------------------------------------------- /exampleSite/config/staging/config.yaml: -------------------------------------------------------------------------------- 1 | # Config for production 2 | baseURL: "/" 3 | -------------------------------------------------------------------------------- /exampleSite/config/staging/params.yaml: -------------------------------------------------------------------------------- 1 | # Params for production (build mode) 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | *~ 3 | .idea/ 4 | .vscode/ 5 | 6 | public 7 | node_modules 8 | -------------------------------------------------------------------------------- /hugo.yaml: -------------------------------------------------------------------------------- 1 | module: 2 | hugoVersion: 3 | extended: true 4 | min: "0.110.0" 5 | -------------------------------------------------------------------------------- /images/tn.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/peaceiris/hugo-theme-iris/HEAD/images/tn.png -------------------------------------------------------------------------------- /layouts/shortcodes/mermaid.html: -------------------------------------------------------------------------------- 1 |
| Command | 15 |Function | 16 |
|---|---|
| ? (Shift+/) | 21 |Bring up this help modal | 22 |
| g+h | 25 |Go to Home | 26 |
| g+p | 29 |Go to Posts | 30 |
| g+e | 33 |Open Editor page on GitHub in a new tab | 34 |
| g+s | 37 |Open Source page on GitHub in a new tab | 38 |
| r | 41 |Reload page | 42 |
56 | {{ if .IsHome }} 57 | {{ .Site.Params.description }} 58 | {{ else }} 59 | {{ .Description }} 60 | {{ end }} 61 |
62 | {{ if $.Site.Params.enableBreadcrumbNavigation }} 63 | {{ partial "breadcrumb" . }} 64 | {{ end }} 65 |{{ partial "canonical-link" . }}
66 | {{ if .Params.draft }} 67 |68 |
71 | 72 | {{ end }} 73 | {{ with .GitInfo }} 74 |75 | {{ i18n "lastmod" . }}: {{ $.Lastmod.Format "2006-01-02" }} 79 |
80 | {{ end }} 81 |Test
124 | 125 | 126 | ``` 127 | 128 | ### Code block with Hugo's internal highlight shortcode 129 | 130 | {{< highlight html >}} 131 | 132 | 133 | 134 | 135 |Test
139 | 140 | 141 | {{< /highlight >}} 142 | 143 | 144 | 145 | ## List Types 146 | 147 | ### Ordered List 148 | 149 | 1. First item 150 | 2. Second item 151 | 3. Third item 152 | 153 | ### Unordered List 154 | 155 | * List item 156 | * Another item 157 | * And another item 158 | 159 | ### Nested list 160 | 161 | * Item 162 | 1. First Sub-item 163 | 2. Second Sub-item 164 | 165 | 166 | 167 | ## Other Elements — abbr, sub, sup, kbd, mark 168 | 169 | GIF is a bitmap image format. 170 | 171 | H2O 172 | 173 | Xn + Yn: Zn 174 | 175 | Press CTRL+ALT+Delete to end the session. 176 | 177 | Most salamanders are nocturnal, and hunt for insects, worms, and other small creatures. 178 | -------------------------------------------------------------------------------- /assets/theme/scss/bulma.scss: -------------------------------------------------------------------------------- 1 | @charset "utf-8"; 2 | 3 | @import "bulma/sass/utilities/_all.sass"; 4 | @import "bulma/sass/base/_all.sass"; 5 | 6 | // ==================== 7 | // helpers 8 | // ==================== 9 | @import "bulma/sass/helpers/float.sass"; 10 | @import "bulma/sass/helpers/color.sass"; 11 | @import "bulma/sass/helpers/typography.sass"; 12 | @import "bulma/sass/helpers/spacing.sass"; 13 | 14 | $dimensions: 16 24 32 48 64 96 128 180 256; 15 | 16 | // ==================== 17 | // components 18 | // ==================== 19 | // @import "bulma/sass/components/_all.sass"; 20 | 21 | $breadcrumb-item-hover-color: gold; 22 | $breadcrumb-item-active-color: $grey-lighter; 23 | @import "bulma/sass/components/breadcrumb.sass"; 24 | 25 | $card-color: $grey-lighter; 26 | $card-header-color: skyblue; 27 | $card-background-color: $grey-dark; 28 | $card-footer-border-top: 1px solid $grey-darker; 29 | @import "bulma/sass/components/card.sass"; 30 | 31 | $dropdown-content-background-color: $grey-dark; 32 | $dropdown-item-color: $grey-lighter; 33 | @import "bulma/sass/components/dropdown.sass"; 34 | // @import "bulma/sass/components/level.sass"; 35 | // @import "bulma/sass/components/list.sass"; 36 | // @import "bulma/sass/components/media.sass"; 37 | // @import "bulma/sass/components/menu.sass"; 38 | // @import "bulma/sass/components/message.sass"; 39 | @import "bulma/sass/components/modal.sass"; 40 | @import "bulma/sass/components/navbar.sass"; 41 | @import "bulma/sass/components/pagination.sass"; 42 | // @import "bulma/sass/components/panel.sass"; 43 | // @import "bulma/sass/components/tabs.sass"; 44 | 45 | // ==================== 46 | // elements 47 | // ==================== 48 | // @import "bulma/sass/elements/_all.sass"; 49 | // @import "bulma/sass/elements/box.sass"; 50 | 51 | $button-color: $grey-lighter; 52 | $button-background-color: $grey-dark; 53 | $button-hover-color: skyblue; 54 | @import "bulma/sass/elements/button.sass"; 55 | @import "bulma/sass/elements/container.sass"; 56 | @import "bulma/sass/elements/content.sass"; 57 | // @import "bulma/sass/elements/form.sass"; 58 | // @import "bulma/sass/elements/icon.sass"; 59 | @import "bulma/sass/elements/image.sass"; 60 | // @import "bulma/sass/elements/notification.sass"; 61 | @import "bulma/sass/elements/other.sass"; 62 | // @import "bulma/sass/elements/progress.sass"; 63 | 64 | $table-color: $grey-lighter; 65 | $table-head-cell-color: gold; 66 | $table-cell-border: 1px solid $grey-darker; 67 | $table-background-color: $grey-dark; 68 | $table-striped-row-even-background-color: $grey-dark; 69 | $table-row-hover-background-color: sienna; 70 | $table-striped-row-even-hover-background-color: sienna; 71 | @import "bulma/sass/elements/table.sass"; 72 | 73 | @import "bulma/sass/elements/tag.sass"; 74 | @import "bulma/sass/elements/title.sass"; 75 | 76 | // ==================== 77 | // form 78 | // ==================== 79 | // @import "bulma/sass/form/_all.sass"; 80 | // @import "bulma/sass/form/checkbox-radio.sass"; 81 | // @import "bulma/sass/form/file.sass"; 82 | // @import "bulma/sass/form/input-textarea.sass"; 83 | // @import "bulma/sass/form/select.sass"; 84 | // @import "bulma/sass/form/shared.sass"; 85 | // @import "bulma/sass/form/tools.sass"; 86 | 87 | // ==================== 88 | // grid 89 | // ==================== 90 | // @import "bulma/sass/grid/_all.sass"; 91 | @import "bulma/sass/grid/columns.sass"; 92 | // @import "bulma/sass/grid/tiles.sass"; 93 | 94 | // ==================== 95 | // layout 96 | // ==================== 97 | @import "bulma/sass/layout/_all.sass"; 98 | 99 | // ==================== 100 | // Iris theme 101 | // ==================== 102 | html { 103 | overflow: auto; 104 | } 105 | 106 | body { 107 | overflow: hidden; 108 | } 109 | 110 | h2 { 111 | border-bottom: solid 2px $grey; 112 | } 113 | 114 | h3 { 115 | margin-top: 2rem; 116 | margin-bottom: 1rem; 117 | padding-left: 0.5em; 118 | border-left: solid 4px #FF7F50; 119 | } 120 | 121 | section.section { 122 | padding: 1.5rem 1.5rem; 123 | } 124 | 125 | pre { 126 | margin: 1rem 0rem; 127 | } 128 | 129 | p:not([class]) { 130 | margin: 1rem 0rem; 131 | line-height: 1.8rem; 132 | } 133 | 134 | .buttons { 135 | margin: 1rem 0rem; 136 | } 137 | 138 | a.normal-link { 139 | text-decoration: none; 140 | color: skyblue; 141 | } 142 | a.normal-link:hover { 143 | text-decoration: underline; 144 | color: skyblue; 145 | } 146 | a { 147 | text-decoration: underline; 148 | color: skyblue; 149 | } 150 | a:hover { 151 | text-decoration: none; 152 | color: gold; 153 | } 154 | a:visited { 155 | color: gold; 156 | } 157 | 158 | strong { 159 | color: $grey-lighter; 160 | } 161 | 162 | code { 163 | background: $grey-dark; 164 | color: gold; 165 | } 166 | 167 | blockquote { 168 | position: relative; 169 | padding: 2rem 1rem 1rem 1rem; 170 | margin: 2rem 0rem; 171 | box-sizing: border-box; 172 | font-style: italic; 173 | background: $grey-dark; 174 | border-left: 0.2rem solid chocolate; 175 | 176 | :before { 177 | display: inline-block; 178 | position: absolute; 179 | top: 0.5rem; 180 | left: 0.3rem; 181 | content: "“"; 182 | font-family: sans-serif; 183 | color: chocolate; 184 | font-size: 5rem; 185 | line-height: 1; 186 | } 187 | 188 | p { 189 | padding: 0rem; 190 | margin: 1rem 0rem; 191 | line-height: 1.7; 192 | color: $grey-lighter; 193 | } 194 | 195 | cite { 196 | display: block; 197 | text-align: right; 198 | color: $grey-lighter; 199 | font-size: 0.9rem; 200 | } 201 | } 202 | 203 | // ==================== 204 | // code shortcode 205 | // ==================== 206 | .highlight { 207 | margin-top: 2rem; 208 | margin-bottom: 2rem !important; 209 | } 210 | .code-block { 211 | margin-top: 1rem; 212 | margin-bottom: 2rem; 213 | } 214 | .code-block-title { 215 | display: inline-block; 216 | color: gray; 217 | position: relative; 218 | bottom: -1rem; 219 | left: 0.5rem; 220 | } 221 | .code-block-body pre { 222 | overflow: auto; 223 | // overflow: scroll; 224 | } 225 | .code-block pre.chroma { 226 | margin-top: 0.3rem; 227 | } 228 | .code-block-lang { 229 | float: right; 230 | color: gray; 231 | position: relative; 232 | bottom: -1rem; 233 | right: 0.5rem; 234 | } 235 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | paths-ignore: 8 | - "README.md" 9 | pull_request: 10 | paths-ignore: 11 | - "README.md" 12 | schedule: 13 | - cron: "13 13 * * *" 14 | workflow_dispatch: 15 | 16 | concurrency: 17 | group: ${{ github.workflow }}-${{ github.ref }} 18 | cancel-in-progress: false 19 | 20 | env: 21 | HUGO_CACHEDIR: /home/runner/.cache/hugo 22 | 23 | jobs: 24 | renovate: 25 | runs-on: ubuntu-22.04 26 | timeout-minutes: 1 27 | permissions: {} 28 | steps: 29 | - uses: actions/checkout@v4 30 | - uses: peaceiris/workflows/setup-node@v0.20.1 31 | with: 32 | node-version-file: ".nvmrc" 33 | cache: "npm" 34 | - run: npm ci 35 | - run: npm run test:renovate 36 | 37 | envs: 38 | runs-on: ubuntu-22.04 39 | timeout-minutes: 2 40 | permissions: {} 41 | outputs: 42 | HUGO_VERSION: ${{ steps.envs.outputs.HUGO_VERSION }} 43 | NODE_VERSION: ${{ steps.envs.outputs.NODE_VERSION }} 44 | steps: 45 | - uses: actions/checkout@v4 46 | 47 | - name: Set envs 48 | id: envs 49 | run: | 50 | echo "HUGO_VERSION=$(make get-hugo-version)" | tee -a "${GITHUB_OUTPUT}" 51 | echo "NODE_VERSION=$(cat .nvmrc)" | tee -a "${GITHUB_OUTPUT}" 52 | 53 | deploy: 54 | needs: envs 55 | runs-on: ubuntu-22.04 56 | timeout-minutes: 3 57 | permissions: 58 | contents: write 59 | deployments: write 60 | pull-requests: write 61 | steps: 62 | - uses: actions/checkout@v4 63 | with: 64 | fetch-depth: 0 65 | 66 | - uses: peaceiris/workflows/setup-hugo@v0.20.1 67 | with: 68 | node-version: "${{ needs.envs.outputs.NODE_VERSION }}" 69 | hugo-version: "${{ needs.envs.outputs.HUGO_VERSION }}" 70 | extended: true 71 | 72 | - run: make npm-ci 73 | 74 | - uses: denoland/setup-deno@v1 75 | with: 76 | deno-version: "v1.x" 77 | 78 | - run: make fetch-data 79 | env: 80 | GITHUB_TOKEN: ${{ secrets.GH_PAT }} 81 | 82 | - run: make build-staging 83 | 84 | - name: Deploy to Netlify 85 | uses: nwtgck/actions-netlify@v3.0.0 86 | with: 87 | publish-dir: "./exampleSite/public" 88 | production-branch: main 89 | github-token: ${{ secrets.GITHUB_TOKEN }} 90 | deploy-message: "Deploy from GitHub Actions" 91 | enable-pull-request-comment: true 92 | enable-commit-comment: false 93 | overwrites-pull-request-comment: true 94 | env: 95 | NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} 96 | NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }} 97 | timeout-minutes: 1 98 | 99 | - run: make build-prod 100 | 101 | - name: Deploy 102 | uses: peaceiris/actions-gh-pages@v4.0.0 103 | if: ${{ github.ref == 'refs/heads/main' }} 104 | with: 105 | #deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} 106 | github_token: ${{ secrets.GITHUB_TOKEN }} 107 | publish_dir: ./exampleSite/public 108 | allow_empty_commit: true 109 | user_name: "github-actions[bot]" 110 | user_email: "github-actions[bot]@users.noreply.github.com" 111 | 112 | lighthouse: 113 | needs: deploy 114 | if: ${{ github.ref == 'refs/heads/main' }} 115 | runs-on: ubuntu-22.04 116 | timeout-minutes: 20 117 | permissions: 118 | contents: write 119 | steps: 120 | - uses: actions/checkout@v4 121 | 122 | - name: Install lighthouse 123 | run: sudo npm i -g lighthouse@11.7.1 124 | 125 | - name: Run lighthouse 126 | run: | 127 | lighthouse \ 128 | --chrome-flags="--headless" \ 129 | --output html --output-path ./report.html \ 130 | 'https://hugothemeiris.peaceiris.com' 131 | 132 | - name: Upload result 133 | uses: actions/upload-artifact@v4 134 | with: 135 | name: lighthouse-report 136 | path: report.html 137 | 138 | - name: Prepare assets 139 | run: | 140 | mkdir ./public 141 | cp ./report.html ./public/report.html 142 | 143 | - name: Deploy 144 | uses: peaceiris/actions-gh-pages@v4.0.0 145 | with: 146 | deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} 147 | publish_dir: ./public 148 | keep_files: true 149 | user_name: "github-actions[bot]" 150 | user_email: "github-actions[bot]@users.noreply.github.com" 151 | 152 | docker: 153 | needs: envs 154 | runs-on: ubuntu-22.04 155 | timeout-minutes: 3 156 | if: ${{ github.event_name == 'push' || github.event_name == 'pull_request' }} 157 | permissions: 158 | contents: read 159 | steps: 160 | - uses: actions/checkout@v4 161 | 162 | - uses: peaceiris/workflows/setup-hugo@v0.20.1 163 | with: 164 | node-version: "${{ needs.envs.outputs.NODE_VERSION }}" 165 | hugo-version: "${{ needs.envs.outputs.HUGO_VERSION }}" 166 | extended: true 167 | 168 | - name: prepare 169 | run: | 170 | sed -i 's/enableGitInfo: true/# enableGitInfo: true/' exampleSite/config/_default/config.yaml 171 | 172 | - run: make docker-build 173 | 174 | setup: 175 | needs: envs 176 | runs-on: ubuntu-22.04 177 | timeout-minutes: 3 178 | if: ${{ github.ref == 'refs/heads/main' }} 179 | permissions: 180 | contents: read 181 | steps: 182 | - uses: actions/checkout@v4 183 | 184 | - uses: peaceiris/workflows/setup-hugo@v0.20.1 185 | with: 186 | node-version: "${{ needs.envs.outputs.NODE_VERSION }}" 187 | hugo-version: "${{ needs.envs.outputs.HUGO_VERSION }}" 188 | extended: true 189 | 190 | - uses: peaceiris/workflows/setup-git@v0.20.1 191 | with: 192 | flags: "--global" 193 | 194 | - name: Create a new Hugo project 195 | run: | 196 | mkdir ~/homepage 197 | cp scripts/setup.sh ~ 198 | cd ~ 199 | bash ./setup.sh "homepage" "peaceiris" 200 | cd homepage 201 | npm ci 202 | hugo 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
7 |
8 | [](https://github.com/peaceiris/hugo-theme-iris/blob/main/LICENSE)
9 | [](https://github.com/peaceiris/hugo-theme-iris/releases/latest)
10 | [](https://github.com/peaceiris/hugo-theme-iris/releases)
11 | [](https://github.com/peaceiris/hugo-theme-iris/releases.atom)
12 | 
13 | [](https://themes.gohugo.io/themes/hugo-theme-iris/)
14 | [](https://hugothemeiris.peaceiris.com/report.html)
15 |
16 |
216 |
217 | ### button
218 |
219 | ```md
220 |
226 | ```
227 |
228 |
229 |
230 | ### mermaid
231 |
232 | ```md
233 | {{< mermaid >}}
234 | sequenceDiagram
235 | participant Alice
236 | participant Bob
237 | Alice->>John: Hello John, how are you?
238 | loop Healthcheck
239 | John->>John: Fight against hypochondria
240 | end
241 | Note right of John: Rational thoughts
249 |
250 | ### repo
251 |
252 | Run the following script to get the latest repository data.
253 | The script requires the [gh] command.
254 |
255 | [gh]: https://github.com/cli/cli
256 |
257 | For more details: [scripts/fetch_data.sh](https://github.com/peaceiris/hugo-theme-iris/blob/main/exampleSite/scripts/fetch_data.sh)
258 |
259 | ```sh
260 | brew install gh
261 | gh auth login
262 | ```
263 |
264 | ```sh
265 | cd ./your_hugo_project
266 | export GH_USER_ID="peaceiris"
267 | bash ./scripts/fetch_data.sh "${GH_USER_ID}" > "./data/github/${GH_USER_ID}.json"
268 | ```
269 |
270 | We can show a repository card like as follows.
271 |
272 | ```md
273 | {{< repo id="peaceiris" name="actions-gh-pages" >}}
274 |
275 | {{< repo id="peaceiris" name="actions-hugo" >}}
276 | ```
277 |
278 |
279 |
280 | ### github-sponsors-list
281 |
282 | Please follow the instruction as the same as the `repo` shortcode.
283 |
284 | ```md
285 | {{< github-sponsors-list id="peaceiris" >}}
286 | ```
287 |
288 |
289 |
290 | ### table
291 |
292 | ```md
293 | {{< table >}}
294 | | Key | Value |
295 | |---|---|
296 | | Static Site Generator | Hugo |
297 | | Language | Go |
298 | {{< /table >}}
299 | ```
300 |
301 | | Mouse out | Mouse over |
302 | |---|---|
303 | |  |  |
304 |
305 | ### math
306 |
307 | See also [the example page](https://hugothemeiris.peaceiris.com/posts/math/).
308 |
309 | When you use the ampersand sign `&`, you need to use the following math shortcode.
310 |
311 | ```md
312 | {{< math >}}
313 | \begin{vmatrix}a & b\\
314 | c & d
315 | \end{vmatrix}
316 | {{< /math >}}
317 | ```
318 |
319 |
320 |
321 |
322 |
323 | ## How to Update the Theme
324 |
325 | ```sh
326 | cd your_hugo_project
327 | hugo mod get -u hugo mod get -u github.com/peaceiris/hugo-theme-iris
328 | hugo mod tidy && hugo mod verify
329 | git add go.mod go.sum
330 | git commit -m "deps: bump hugo-theme-iris"
331 | ```
332 |
333 |
334 |
335 |
336 |
337 | ## Special Thanks
338 |
339 | - [Hugo]
340 | - [Bulma]
341 | - [reveal.js]
342 | - [MathJax]
343 | - [mermaid]
344 | - [jaywcjlove/hotkeys](https://github.com/jaywcjlove/hotkeys)
345 |
346 |
347 |
348 |
349 |
350 |
351 |
352 | ## Changelog
353 |
354 | - [hugo-theme-iris/CHANGELOG.md](https://github.com/peaceiris/hugo-theme-iris/blob/main/CHANGELOG.md)
355 |
356 |
357 |
358 | ## Maintainer
359 |
360 | - [peaceiris homepage](https://peaceiris.com)
361 |
362 |
363 |
364 | ## Contributing
365 |
366 | To contribute to this Hugo theme.
367 |
368 | You can find more detail in our [Contributing Guide].
369 |
370 |
371 |
372 | ## License
373 |
374 | - [MIT License - peaceiris/hugo-theme-iris](https://github.com/peaceiris/hugo-theme-iris/blob/main/LICENSE)
375 |
376 |
377 |
378 | ## Development
379 |
380 | ```sh
381 | {{ partial "console-log" $hoge }}
382 | ```
383 |
384 | ---
385 |
386 |
387 |
388 |
389 |
390 |
391 | [Contributing Guide]: https://github.com/peaceiris/hugo-theme-iris/blob/main/CONTRIBUTING.md
392 |
393 |
394 | [Hugo]: https://gohugo.io/
395 | [Bulma]: https://bulma.io/
396 | [reveal.js]: https://github.com/hakimel/reveal.js/
397 | [MathJax]: https://www.mathjax.org/
398 | [mermaid]: https://github.com/knsv/mermaid
399 |
--------------------------------------------------------------------------------
/exampleSite/data/github/peaceiris.json:
--------------------------------------------------------------------------------
1 | {"data":{"user":{"login":"peaceiris","sponsorshipsAsMaintainer":{"nodes":[{"sponsor":{"login":"otiai10"}},{"sponsor":{"login":"danmindru"}},{"sponsor":{"login":"jambonrose"}},{"sponsor":{"login":"tinhb92"}},{"sponsor":{"login":"niki"}},{"sponsor":{"login":"say3no"}},{"sponsor":{"login":"ny-a"}}]},"repositories":{"nodes":[{"nameWithOwner":"peaceiris/actions-gh-pages","owner":{"login":"peaceiris"},"name":"actions-gh-pages","description":"GitHub Actions for GitHub Pages 🚀 Deploy static files and publish your site easily. Static-Site-Generators-friendly.","url":"https://github.com/peaceiris/actions-gh-pages","primaryLanguage":{"name":"TypeScript"},"forkCount":342,"stargazers":{"totalCount":4404}},{"nameWithOwner":"peaceiris/actions-hugo","owner":{"login":"peaceiris"},"name":"actions-hugo","description":"GitHub Actions for Hugo ⚡️ Setup Hugo quickly and build your site fast. Hugo extended, Hugo Modules, Linux (Ubuntu), macOS, and Windows are supported.","url":"https://github.com/peaceiris/actions-hugo","primaryLanguage":{"name":"TypeScript"},"forkCount":79,"stargazers":{"totalCount":1340}},{"nameWithOwner":"peaceiris/emoji-ime-dictionary","owner":{"login":"peaceiris"},"name":"emoji-ime-dictionary","description":"日本語で絵文字入力をするための IME 追加辞書 📙 Google 日本語入力などで日本語から絵文字への変換を可能にする IME 拡張辞書","url":"https://github.com/peaceiris/emoji-ime-dictionary","primaryLanguage":{"name":"Python"},"forkCount":18,"stargazers":{"totalCount":328}},{"nameWithOwner":"peaceiris/actions-mdbook","owner":{"login":"peaceiris"},"name":"actions-mdbook","description":"GitHub Actions for mdBook (rust-lang/mdBook) ⚡️ Setup mdBook quickly and build your site fast. Linux (Ubuntu), macOS, and Windows are supported.","url":"https://github.com/peaceiris/actions-mdbook","primaryLanguage":{"name":"TypeScript"},"forkCount":20,"stargazers":{"totalCount":276}},{"nameWithOwner":"peaceiris/mkdocs-material-boilerplate","owner":{"login":"peaceiris"},"name":"mkdocs-material-boilerplate","description":"MkDocs Material Boilerplate (Starter Kit) - Deploy documentation to hosting platforms (Netlify, GitHub Pages, GitLab Pages, and AWS Amplify Console) with Docker, pipenv, and GitHub Actions.","url":"https://github.com/peaceiris/mkdocs-material-boilerplate","primaryLanguage":{"name":"Python"},"forkCount":52,"stargazers":{"totalCount":116}},{"nameWithOwner":"peaceiris/actions-label-commenter","owner":{"login":"peaceiris"},"name":"actions-label-commenter","description":"Label Commenter Action: Label triggered GitHub Action for posting a template comment, and automatically open/close/lock/unlock issues, pull-requests, and discussions.","url":"https://github.com/peaceiris/actions-label-commenter","primaryLanguage":{"name":"TypeScript"},"forkCount":16,"stargazers":{"totalCount":80}},{"nameWithOwner":"peaceiris/google-ime-dictionary","owner":{"login":"peaceiris"},"name":"google-ime-dictionary","description":"日英変換・英語略語展開のための IME 追加辞書 📙 日本語から英語への和英変換や英語略語の展開を Google 日本語入力や ATOK などで可能にする IME 拡張辞書","url":"https://github.com/peaceiris/google-ime-dictionary","primaryLanguage":{"name":"Shell"},"forkCount":5,"stargazers":{"totalCount":74}},{"nameWithOwner":"peaceiris/hugo-theme-iris","owner":{"login":"peaceiris"},"name":"hugo-theme-iris","description":"Hugo IRIS Theme - Portfolio and Blog","url":"https://github.com/peaceiris/hugo-theme-iris","primaryLanguage":{"name":"HTML"},"forkCount":18,"stargazers":{"totalCount":66}},{"nameWithOwner":"peaceiris/hugo-extended-docker","owner":{"login":"peaceiris"},"name":"hugo-extended-docker","description":"Debian Based Docker Image for Hugo (Hugo extended and Hugo Modules)","url":"https://github.com/peaceiris/hugo-extended-docker","primaryLanguage":{"name":"Makefile"},"forkCount":9,"stargazers":{"totalCount":56}},{"nameWithOwner":"peaceiris/docker-mdbook","owner":{"login":"peaceiris"},"name":"docker-mdbook","description":"mdBook Alpine Base Docker Image.","url":"https://github.com/peaceiris/docker-mdbook","primaryLanguage":{"name":"Dockerfile"},"forkCount":11,"stargazers":{"totalCount":41}},{"nameWithOwner":"peaceiris/actions-suggest-related-links","owner":{"login":"peaceiris"},"name":"actions-suggest-related-links","description":"A GitHub Action to suggest related or similar issues, documents, and links. Based on the power of NLP and fastText.","url":"https://github.com/peaceiris/actions-suggest-related-links","primaryLanguage":{"name":"TypeScript"},"forkCount":2,"stargazers":{"totalCount":29}},{"nameWithOwner":"peaceiris/actions-self-hosted-runners","owner":{"login":"peaceiris"},"name":"actions-self-hosted-runners","description":"GitHub Actions self-hosted runner on VirtualBox with Vagrant.","url":"https://github.com/peaceiris/actions-self-hosted-runners","primaryLanguage":{"name":"Shell"},"forkCount":7,"stargazers":{"totalCount":13}},{"nameWithOwner":"peaceiris/actions-github-pages","owner":{"login":"peaceiris"},"name":"actions-github-pages","description":"The v3 implementation of GitHub Actions for GitHub Pages.","url":"https://github.com/peaceiris/actions-github-pages","primaryLanguage":{"name":"TypeScript"},"forkCount":0,"stargazers":{"totalCount":12}},{"nameWithOwner":"peaceiris/actions-pixela","owner":{"login":"peaceiris"},"name":"actions-pixela","description":"GitHub Actions for Pixela (a-know/pi) - a-know/pi Setup Action. Linux (Ubuntu), macOS, and Windows are supported.","url":"https://github.com/peaceiris/actions-pixela","primaryLanguage":{"name":"TypeScript"},"forkCount":2,"stargazers":{"totalCount":12}},{"nameWithOwner":"peaceiris/actions-broken-link-checker","owner":{"login":"peaceiris"},"name":"actions-broken-link-checker","description":"GitHub Actions for broken-link-checker (Find broken links, missing images, etc in your HTML)","url":"https://github.com/peaceiris/actions-broken-link-checker","primaryLanguage":{"name":"Dockerfile"},"forkCount":0,"stargazers":{"totalCount":8}},{"nameWithOwner":"abema/github-actions-merger","owner":{"login":"abema"},"name":"github-actions-merger","description":"Github actions that merge pull requests with custom ways","url":"https://github.com/abema/github-actions-merger","primaryLanguage":{"name":"Go"},"forkCount":2,"stargazers":{"totalCount":7}},{"nameWithOwner":"peaceiris/actions-pipenv","owner":{"login":"peaceiris"},"name":"actions-pipenv","description":"GitHub Actions for Python project with pipenv","url":"https://github.com/peaceiris/actions-pipenv","primaryLanguage":{"name":"Dockerfile"},"forkCount":1,"stargazers":{"totalCount":6}},{"nameWithOwner":"peaceiris/hugo-mod-bulma","owner":{"login":"peaceiris"},"name":"hugo-mod-bulma","description":"Bulma packaged as a Hugo Module.","url":"https://github.com/peaceiris/hugo-mod-bulma","primaryLanguage":null,"forkCount":1,"stargazers":{"totalCount":5}},{"nameWithOwner":"peaceiris/actions-hugo-link-check","owner":{"login":"peaceiris"},"name":"actions-hugo-link-check","description":"GitHub Actions to check broken links for Hugo","url":"https://github.com/peaceiris/actions-hugo-link-check","primaryLanguage":{"name":"Dockerfile"},"forkCount":0,"stargazers":{"totalCount":5}},{"nameWithOwner":"peaceiris/hugo-mod-mathjax","owner":{"login":"peaceiris"},"name":"hugo-mod-mathjax","description":"MathJax packaged as a Hugo Module.","url":"https://github.com/peaceiris/hugo-mod-mathjax","primaryLanguage":null,"forkCount":0,"stargazers":{"totalCount":4}},{"nameWithOwner":"peaceiris/hugo-mod-mermaidjs","owner":{"login":"peaceiris"},"name":"hugo-mod-mermaidjs","description":"mermaid-js/mermaid packaged as a Hugo Module.","url":"https://github.com/peaceiris/hugo-mod-mermaidjs","primaryLanguage":null,"forkCount":1,"stargazers":{"totalCount":4}},{"nameWithOwner":"peaceiris/workflows","owner":{"login":"peaceiris"},"name":"workflows","description":"GitHub Actions Composite/Reusable Workflows","url":"https://github.com/peaceiris/workflows","primaryLanguage":null,"forkCount":1,"stargazers":{"totalCount":4}},{"nameWithOwner":"peaceiris/hugo-mod-revealjs","owner":{"login":"peaceiris"},"name":"hugo-mod-revealjs","description":"reveal.js packaged as a Hugo Module.","url":"https://github.com/peaceiris/hugo-mod-revealjs","primaryLanguage":null,"forkCount":0,"stargazers":{"totalCount":3}},{"nameWithOwner":"peaceiris/docker-latex","owner":{"login":"peaceiris"},"name":"docker-latex","description":"Docker image for LaTeX","url":"https://github.com/peaceiris/docker-latex","primaryLanguage":{"name":"Dockerfile"},"forkCount":0,"stargazers":{"totalCount":3}},{"nameWithOwner":"peaceiris/actions-liche","owner":{"login":"peaceiris"},"name":"actions-liche","description":"GitHub Actions for liche (Fast Link Checker for Markdown and HTML in Go)","url":"https://github.com/peaceiris/actions-liche","primaryLanguage":{"name":"Dockerfile"},"forkCount":0,"stargazers":{"totalCount":3}},{"nameWithOwner":"peaceiris/actions-muffet","owner":{"login":"peaceiris"},"name":"actions-muffet","description":"GitHub Actions for muffet (Fast website link checker in Go)","url":"https://github.com/peaceiris/actions-muffet","primaryLanguage":{"name":"Dockerfile"},"forkCount":4,"stargazers":{"totalCount":3}},{"nameWithOwner":"peaceiris/actions-mkdocs-gh-pages","owner":{"login":"peaceiris"},"name":"actions-mkdocs-gh-pages","description":"GitHub Actions for MkDocs and GitHub Pages - Build markdown documentation with Material for MkDocs and deploy to GitHub Pages automatically","url":"https://github.com/peaceiris/actions-mkdocs-gh-pages","primaryLanguage":{"name":"Shell"},"forkCount":1,"stargazers":{"totalCount":3}},{"nameWithOwner":"peaceiris/actions-export-envs","owner":{"login":"peaceiris"},"name":"actions-export-envs","description":"Exporting ACTIONS_RUNTIME_TOKEN and ACTIONS_CACHE_URL to enable the Docker layer caching on GitHub Actions.","url":"https://github.com/peaceiris/actions-export-envs","primaryLanguage":{"name":"Shell"},"forkCount":0,"stargazers":{"totalCount":2}},{"nameWithOwner":"dionomusuko/gh-release-with-wf-dispatch","owner":{"login":"dionomusuko"},"name":"gh-release-with-wf-dispatch","description":null,"url":"https://github.com/dionomusuko/gh-release-with-wf-dispatch","primaryLanguage":{"name":"Go"},"forkCount":3,"stargazers":{"totalCount":2}},{"nameWithOwner":"peaceiris/mlops","owner":{"login":"peaceiris"},"name":"mlops","description":"MLOps and DevOps Playground","url":"https://github.com/peaceiris/mlops","primaryLanguage":null,"forkCount":0,"stargazers":{"totalCount":2}},{"nameWithOwner":"peaceiris/peaceiris","owner":{"login":"peaceiris"},"name":"peaceiris","description":"About peaceiris","url":"https://github.com/peaceiris/peaceiris","primaryLanguage":null,"forkCount":0,"stargazers":{"totalCount":2}},{"nameWithOwner":"peaceiris/actions-github-app-token","owner":{"login":"peaceiris"},"name":"actions-github-app-token","description":"A GitHub Action to generate a token for GitHub Apps","url":"https://github.com/peaceiris/actions-github-app-token","primaryLanguage":{"name":"TypeScript"},"forkCount":0,"stargazers":{"totalCount":1}},{"nameWithOwner":"peaceiris/test-sphinx","owner":{"login":"peaceiris"},"name":"test-sphinx","description":null,"url":"https://github.com/peaceiris/test-sphinx","primaryLanguage":{"name":"Python"},"forkCount":0,"stargazers":{"totalCount":1}},{"nameWithOwner":"peaceiris/investigate-hugo-hanging","owner":{"login":"peaceiris"},"name":"investigate-hugo-hanging","description":"A repository to investigate a hanging of Hugo on GitHub Actions","url":"https://github.com/peaceiris/investigate-hugo-hanging","primaryLanguage":{"name":"HTML"},"forkCount":1,"stargazers":{"totalCount":1}},{"nameWithOwner":"peaceiris/tss","owner":{"login":"peaceiris"},"name":"tss","description":"Annotate stdin with timestamps per line. A Go port of moreutils/ts and fork of kevinburke/tss.","url":"https://github.com/peaceiris/tss","primaryLanguage":{"name":"Go"},"forkCount":0,"stargazers":{"totalCount":1}},{"nameWithOwner":"peaceiris/Hatena-Intern-2020","owner":{"login":"peaceiris"},"name":"Hatena-Intern-2020","description":null,"url":"https://github.com/peaceiris/Hatena-Intern-2020","primaryLanguage":{"name":"Go"},"forkCount":0,"stargazers":{"totalCount":1}},{"nameWithOwner":"peaceiris/test-docusaurus","owner":{"login":"peaceiris"},"name":"test-docusaurus","description":"GitHub Pages and GitHub Actions example for facebook/docusaurus https://test-docusaurus.peaceiris.com/","url":"https://github.com/peaceiris/test-docusaurus","primaryLanguage":{"name":"JavaScript"},"forkCount":4,"stargazers":{"totalCount":1}},{"nameWithOwner":"peaceiris/actions-utils","owner":{"login":"peaceiris"},"name":"actions-utils","description":"Utilities for the GitHub Actions.","url":"https://github.com/peaceiris/actions-utils","primaryLanguage":{"name":"JavaScript"},"forkCount":0,"stargazers":{"totalCount":1}},{"nameWithOwner":"peaceiris/test-hugo-external-repo","owner":{"login":"peaceiris"},"name":"test-hugo-external-repo","description":"Test repo: Deploy from https://github.com/peaceiris/hugo-test-project","url":"https://github.com/peaceiris/test-hugo-external-repo","primaryLanguage":{"name":"HTML"},"forkCount":0,"stargazers":{"totalCount":1}},{"nameWithOwner":"peaceiris/gatsby-test","owner":{"login":"peaceiris"},"name":"gatsby-test","description":"Log: https://github.com/peaceiris/gatsby-test/commits/gh-pages","url":"https://github.com/peaceiris/gatsby-test","primaryLanguage":{"name":"JavaScript"},"forkCount":1,"stargazers":{"totalCount":1}},{"nameWithOwner":"peaceiris/contents","owner":{"login":"peaceiris"},"name":"contents","description":"Blog contents","url":"https://github.com/peaceiris/contents","primaryLanguage":null,"forkCount":0,"stargazers":{"totalCount":1}},{"nameWithOwner":"peaceiris/netlify-search-function","owner":{"login":"peaceiris"},"name":"netlify-search-function","description":null,"url":"https://github.com/peaceiris/netlify-search-function","primaryLanguage":{"name":"Go"},"forkCount":1,"stargazers":{"totalCount":1}},{"nameWithOwner":"peaceiris/test-mdbook","owner":{"login":"peaceiris"},"name":"test-mdbook","description":null,"url":"https://github.com/peaceiris/test-mdbook","primaryLanguage":null,"forkCount":0,"stargazers":{"totalCount":0}},{"nameWithOwner":"peaceiris/renovate-config","owner":{"login":"peaceiris"},"name":"renovate-config","description":"peaceiris renovate-config","url":"https://github.com/peaceiris/renovate-config","primaryLanguage":null,"forkCount":0,"stargazers":{"totalCount":0}},{"nameWithOwner":"peaceiris/actions-go-sdk","owner":{"login":"peaceiris"},"name":"actions-go-sdk","description":null,"url":"https://github.com/peaceiris/actions-go-sdk","primaryLanguage":null,"forkCount":0,"stargazers":{"totalCount":0}},{"nameWithOwner":"peaceiris/test-monorepo-release-action","owner":{"login":"peaceiris"},"name":"test-monorepo-release-action","description":null,"url":"https://github.com/peaceiris/test-monorepo-release-action","primaryLanguage":null,"forkCount":0,"stargazers":{"totalCount":0}},{"nameWithOwner":"peaceiris/docker-images","owner":{"login":"peaceiris"},"name":"docker-images","description":"A collection of Docker images","url":"https://github.com/peaceiris/docker-images","primaryLanguage":{"name":"Dockerfile"},"forkCount":0,"stargazers":{"totalCount":0}},{"nameWithOwner":"peaceiris/docker-action","owner":{"login":"peaceiris"},"name":"docker-action","description":"A template to build a Docker action","url":"https://github.com/peaceiris/docker-action","primaryLanguage":null,"forkCount":0,"stargazers":{"totalCount":0}},{"nameWithOwner":"peaceiris/actions-esa","owner":{"login":"peaceiris"},"name":"actions-esa","description":null,"url":"https://github.com/peaceiris/actions-esa","primaryLanguage":null,"forkCount":0,"stargazers":{"totalCount":0}},{"nameWithOwner":"peaceiris/playground-actions","owner":{"login":"peaceiris"},"name":"playground-actions","description":null,"url":"https://github.com/peaceiris/playground-actions","primaryLanguage":null,"forkCount":0,"stargazers":{"totalCount":0}}]}}}}
--------------------------------------------------------------------------------