{"id":20629700,"url":"https://github.com/agile-lab-dev/honkit-plugin-holaspirit","last_synced_at":"2025-10-17T21:24:42.292Z","repository":{"id":39707700,"uuid":"453932669","full_name":"agile-lab-dev/honkit-plugin-holaspirit","owner":"agile-lab-dev","description":"Honkit plugin to embed Holaspirit roles inside rendered markdown pages","archived":false,"fork":false,"pushed_at":"2023-12-15T14:46:15.000Z","size":76,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-10-16T01:05:10.574Z","etag":null,"topics":["docs-like-code","gitbook","honkit"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/agile-lab-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2022-01-31T08:41:42.000Z","updated_at":"2022-05-27T13:07:13.000Z","dependencies_parsed_at":"2024-09-08T21:08:19.980Z","dependency_job_id":"f22075fe-5ea3-4693-b0b4-0e8e31f05fdd","html_url":"https://github.com/agile-lab-dev/honkit-plugin-holaspirit","commit_stats":{"total_commits":5,"total_committers":2,"mean_commits":2.5,"dds":"0.19999999999999996","last_synced_commit":"5f1702b6fb0811d84cffba7b59e6e7e387222671"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agile-lab-dev%2Fhonkit-plugin-holaspirit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agile-lab-dev%2Fhonkit-plugin-holaspirit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agile-lab-dev%2Fhonkit-plugin-holaspirit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agile-lab-dev%2Fhonkit-plugin-holaspirit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/agile-lab-dev","download_url":"https://codeload.github.com/agile-lab-dev/honkit-plugin-holaspirit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242583025,"owners_count":20153369,"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":["docs-like-code","gitbook","honkit"],"created_at":"2024-11-16T14:05:41.838Z","updated_at":"2025-10-17T21:24:42.228Z","avatar_url":"https://github.com/agile-lab-dev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Honkit Holaspirit plugin\n\nAn Honkit book plugin to automatically convert roles notations into Holaspirit links.\n\n## Usage\n\nFor any role you would like to convert to a Holaspirit link just rewrite it as:\n\n```raw\n{% role %}\u003ccircle name\u003e/\u003crole name\u003e{% endrole %}\n```\n\nWhere circle name is the parent circle for the role. As defined in your circles.\n\n## Installation\n\n```bash\nnpm i --save-dev honkit-plugin-holaspirit\n```\n\nThen add `holaspirit` inside `plugins` and `pluginsConfig` properties in your book.json, as shown below:\n\n```json\n{\n\t\"plugins\": [\n\t\t\"holaspirit\",\n\t\t//...other plugins\n\t],\n\t\"pluginsConfig\": {\n\t\t\"holaspirit\": {\n\t\t\t\"token\": \"env://\u003cENV_VARIABLE_NAME_HERE\u003e\" //or \"token://\u003cYOUR_TOKEN_HERE\u003e\",\n\t\t\t\"organizationId\": \"\u003cYOUR_ORGANIZATION_ID_HERE\u003e\"\n\t\t},\n\t\t//...other plugins configs...\n\t}\n\t//...other configurations variables\n}\n```\n\nMake sure to replace `token` and `organizationId` with the correct information:\n\n- **organizationId** of your organization account in Holaspirit. This can be obtained by looking at Hasura URL when navigating the website. They are in the form: `https://app.holaspirit.com/o/\u003cORGANIZATION_ID\u003e/governance/chart`\n- **access token** must be requested to the Holaspirit support. This is a read-only access token to use Holaspirit APIs.\n\nYou can supply the token in two ways:\n\n- by specifying the environment *variable name* to look for (e.g. `env://holaspirit_token`)\n- from the configuration file itself (e.g. `token://abcdefGHI371s`)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagile-lab-dev%2Fhonkit-plugin-holaspirit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagile-lab-dev%2Fhonkit-plugin-holaspirit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagile-lab-dev%2Fhonkit-plugin-holaspirit/lists"}