https://github.com/inventsable/minion-pages
Dynamically retrieve help pages inside a CEP panel from Github repo, no updating or reinstallation needed
https://github.com/inventsable/minion-pages
Last synced: 9 months ago
JSON representation
Dynamically retrieve help pages inside a CEP panel from Github repo, no updating or reinstallation needed
- Host: GitHub
- URL: https://github.com/inventsable/minion-pages
- Owner: Inventsable
- Created: 2023-02-21T01:19:31.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-14T06:11:30.000Z (over 1 year ago)
- Last Synced: 2025-05-07T22:12:56.225Z (11 months ago)
- Language: TypeScript
- Size: 99.6 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# minion help pages
Dynamically retrieving help pages inside a CEP panel from a Github repo. Why update a website with help docs when the panel can update it's own help section in real-time without needing any updates or reinstallation?
## Usage
```bash
# npm run convert [name of folder]
npm run convert key-minion
```
```js
// Sometime before page render, like panel launch:
const user = "Inventsable";
const repo = "minion-pages";
const file = "key-minion.json";
let data = await fetch(
`https://raw.githubusercontent.com/${user}/${repo}/master/results/${file}`
);
let pageJSON = JSON.parse(data.text());
console.log(pageJSON); // { pages: [ ... ], name: ... }
```
