{"id":21344796,"url":"https://github.com/gethinode/mod-mermaid","last_synced_at":"2026-02-17T17:01:02.641Z","repository":{"id":241083520,"uuid":"804238655","full_name":"gethinode/mod-mermaid","owner":"gethinode","description":"A Hugo module to add diagrams and charts powered by Mermaid to your Hinode site","archived":false,"fork":false,"pushed_at":"2026-02-10T04:03:47.000Z","size":12287,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-10T09:34:59.183Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/gethinode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-05-22T08:07:53.000Z","updated_at":"2026-02-10T04:03:51.000Z","dependencies_parsed_at":"2026-02-10T06:03:00.540Z","dependency_job_id":null,"html_url":"https://github.com/gethinode/mod-mermaid","commit_stats":null,"previous_names":["gethinode/mod-mermaid"],"tags_count":32,"template":false,"template_full_name":"gethinode/mod-template","purl":"pkg:github/gethinode/mod-mermaid","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gethinode%2Fmod-mermaid","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gethinode%2Fmod-mermaid/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gethinode%2Fmod-mermaid/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gethinode%2Fmod-mermaid/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gethinode","download_url":"https://codeload.github.com/gethinode/mod-mermaid/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gethinode%2Fmod-mermaid/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29550803,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-17T14:33:00.708Z","status":"ssl_error","status_checked_at":"2026-02-17T14:32:58.657Z","response_time":100,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2024-11-22T01:22:24.237Z","updated_at":"2026-02-17T17:01:02.635Z","avatar_url":"https://github.com/gethinode.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hinode Module - Mermaid\n\n\u003c!-- Tagline --\u003e\n\u003cp align=\"center\"\u003e\n    \u003cb\u003eA Hugo module to add diagrams and charts powered by Mermaid to your Hinode site\u003c/b\u003e\n    \u003cbr /\u003e\n\u003c/p\u003e\n\n\u003c!-- Badges --\u003e\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://gohugo.io\" alt=\"Hugo website\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/generator-hugo-brightgreen\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://gethinode.com\" alt=\"Hinode theme\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/theme-hinode-blue\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/gethinode/mod-mermaid/commits/main\" alt=\"Last commit\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/last-commit/gethinode/mod-mermaid.svg\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/gethinode/mod-mermaid/issues\" alt=\"Issues\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/issues/gethinode/mod-mermaid.svg\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/gethinode/mod-mermaid/pulls\" alt=\"Pulls\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/issues-pr-raw/gethinode/mod-mermaid.svg\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/gethinode/mod-mermaid/blob/main/LICENSE\" alt=\"License\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/license/gethinode/mod-mermaid\"\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n## About\n\n![Logo](https://raw.githubusercontent.com/gethinode/hinode/main/static/img/logo.png)\n\nHinode is a clean blog theme for [Hugo][hugo], an open-source static site generator. Hinode is available as a [template][repository_template], and a [main theme][repository]. This repository maintains a Hugo module to add [Mermaid][mermaid] to a Hinode site. Visit the Hinode documentation site for [installation instructions][hinode_docs].\n\n## Usage\n\nThe module is \"optional\" per default. In this case the module must be enabled in the frontmatter of the pages that use mermaid by adding: `modules: [\"mermaid\"]`\n\nMermaid can be used in fenced codeblocks:\n\n\u003cpre\u003e\n```mermaid\nYOUR DIAGRAMS\n```\n\u003c/pre\u003e\n\nor as shortcode:\n\n\u003cpre\u003e\n{{\u003c mermaid \u003e}}\nYOUR DIAGRAM\n{{\u003c /mermaid \u003e}}\n\u003c/pre\u003e\n\nThe module supports dark mode and allows creation of a custom mermaid theme by overriding and setting the theme variables in `assets/scss/mermaid.scss`. Checkout the [mermaid docs](https://mermaid.js.org/config/theming.html) for custom styling. All theme variables can be used, but in kebab case and with prefix as shown in the example below. Also Bootstrap theme variables can be referenced.\n\n```scss\n// assets/scss/mermaid.scss\n\n[data-mermaid-theme=\"light\"] {\n    // The Mermaid Theme (only 'base' does support custom theming)\n    --mermaid-theme: 'base';\n    // General Theme Variables\n    --mermaid-dark-mode: false;\n    --mermaid-background: var(--bs-body-bg);\n    --mermaid-font-family: var(--bs-font-sans-serif);\n    //...\n}\n\n[data-mermaid-theme=\"dark\"] {\n    // The Mermaid Theme (only 'base' does support custom theming)\n    --mermaid-theme: 'base';\n    // General Theme Variables\n    --mermaid-dark-mode: true;\n    --mermaid-background: var(--bs-body-bg);\n    --mermaid-font-family: var(--bs-font-sans-serif);\n    //...\n}\n```\n\n## Configuration\n\nThis module supports the following parameters (see the section `params.modules` in `config.toml`):\n\n| Setting        | Default   | Description |\n|----------------|-----------|-------------|\n| mermaid.elk    | false     | If set, installs the layout engine for Mermaid based on the ELK layout engine. |\n| mermaid.layout | `dagre`   | Defines which layout algorithm to use for rendering Mermaid diagrams. The default algorithm is `dagre`. Additional options are available when `mermaid.elk` is enabled, see the table below. |\n| mermaid.look   | `classic` | Defines the default look for Mermaid diagrams, either `classic` or `handDrawn`. |\n\nThe following table defines the available layout algorithms. The `elk` values require installation of the ELK layout engine (set `mermaid.elk` to `true`).\n\n| Layout           | Description |\n|------------------|-------------|\n| dagre            | The default Mermaid layout. |\n| elk              | The default ELK layout, which is `elk.layered`. |\n| elk.layered      | Layered layout. |\n| elk.stress       | Stress layout. |\n| elk.force        | Force layout. |\n| elk.mrtree       | Multi-root tree layout. |\n| elk.sporeOverlap | Spore overlap layout. |\n\n## Contributing\n\nThis module uses [semantic-release][semantic-release] to automate the release of new versions. The package uses `husky` and `commitlint` to ensure commit messages adhere to the [Conventional Commits][conventionalcommits] specification. You can run `npx git-cz` from the terminal to help prepare the commit message.\n\n\u003c!-- MARKDOWN LINKS --\u003e\n[hugo]: https://gohugo.io\n[hinode_docs]: https://gethinode.com\n[mermaid]: https://mermaid.js.org\n[repository]: https://github.com/gethinode/hinode.git\n[repository_template]: https://github.com/gethinode/template.git\n[conventionalcommits]: https://www.conventionalcommits.org\n[husky]: https://typicode.github.io/husky/\n[semantic-release]: https://semantic-release.gitbook.io/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgethinode%2Fmod-mermaid","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgethinode%2Fmod-mermaid","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgethinode%2Fmod-mermaid/lists"}