https://github.com/agile-lab-dev/honkit-plugin-holaspirit
Honkit plugin to embed Holaspirit roles inside rendered markdown pages
https://github.com/agile-lab-dev/honkit-plugin-holaspirit
docs-like-code gitbook honkit
Last synced: 8 months ago
JSON representation
Honkit plugin to embed Holaspirit roles inside rendered markdown pages
- Host: GitHub
- URL: https://github.com/agile-lab-dev/honkit-plugin-holaspirit
- Owner: agile-lab-dev
- Created: 2022-01-31T08:41:42.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T14:46:15.000Z (over 2 years ago)
- Last Synced: 2024-10-16T01:05:10.574Z (over 1 year ago)
- Topics: docs-like-code, gitbook, honkit
- Language: TypeScript
- Homepage:
- Size: 74.2 KB
- Stars: 1
- Watchers: 7
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Honkit Holaspirit plugin
An Honkit book plugin to automatically convert roles notations into Holaspirit links.
## Usage
For any role you would like to convert to a Holaspirit link just rewrite it as:
```raw
{% role %}/{% endrole %}
```
Where circle name is the parent circle for the role. As defined in your circles.
## Installation
```bash
npm i --save-dev honkit-plugin-holaspirit
```
Then add `holaspirit` inside `plugins` and `pluginsConfig` properties in your book.json, as shown below:
```json
{
"plugins": [
"holaspirit",
//...other plugins
],
"pluginsConfig": {
"holaspirit": {
"token": "env://" //or "token://",
"organizationId": ""
},
//...other plugins configs...
}
//...other configurations variables
}
```
Make sure to replace `token` and `organizationId` with the correct information:
- **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//governance/chart`
- **access token** must be requested to the Holaspirit support. This is a read-only access token to use Holaspirit APIs.
You can supply the token in two ways:
- by specifying the environment *variable name* to look for (e.g. `env://holaspirit_token`)
- from the configuration file itself (e.g. `token://abcdefGHI371s`)