https://github.com/blinkk/amagaki-plugin-greenhouse

An Amagaki plugin providing basic integration with Greenhouse. Fetches job content from Greenhouse so it can be customized on a website.
https://github.com/blinkk/amagaki-plugin-greenhouse

amagaki greenhouse

Last synced: about 4 hours ago
JSON representation

An Amagaki plugin providing basic integration with Greenhouse. Fetches job content from Greenhouse so it can be customized on a website.

• Host: GitHub
• URL: https://github.com/blinkk/amagaki-plugin-greenhouse
• Owner: blinkk
• Created: 2021-11-03T17:27:55.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-03T20:07:17.000Z (about 3 years ago)
• Last Synced: 2024-12-15T14:09:48.632Z (30 days ago)
• Topics: amagaki, greenhouse
• Language: TypeScript
• Homepage:
• Size: 868 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# amagaki-plugin-greenhouse

[![NPM Version][npm-image]][npm-url]

[![GitHub Actions][github-image]][github-url]

[![TypeScript Style Guide][gts-image]][gts-url]

An Amagaki plugin for fetching content from Greenhouse. By default, content is

sanitized using [DOMPurify](https://github.com/cure53/DOMPurify).

## Usage

### As a plugin

1. Install the plugin.

```shell

npm install --save @amagaki/amagaki-plugin-greenhouse

```

2. Add to `amagaki.ts`.

```typescript

import {GreenhousePlugin} from '@amagaki/amagaki-plugin-greenhouse';

import {BuilderPlugin, Pod} from '@amagaki/amagaki';

export default (pod: Pod) => {

  // Sync Greenhouse prior to building.

  const builderPlugin = pod.plugins.get('BuilderPlugin') as BuilderPlugin;

  builderPlugin.addBeforeBuildStep(async () => {

    const greenhouse = GreenhousePlugin.register(pod, {

      boardToken: 'boardToken',

    });

    await greenhouse.bindCollection({

      collectionPath: '/content/jobs',

    });

    await greenhouse.saveEducationFile({

      podPath: '/content/partials/education.yaml',

    });

  });

};

```

### Via the CLI

This package is also distributed with a CLI so you can download Greenhouse job

board data without using Amagaki.

```

npx @amagaki/amagaki-plugin-greenhouse download \

  -b  \

  -j  \

  -e  \

  [root]

```

[github-image]: https://github.com/blinkk/amagaki-plugin-greenhouse/workflows/Run%20tests/badge.svg

[github-url]: https://github.com/blinkk/amagaki-plugin-greenhouse/actions

[npm-image]: https://img.shields.io/npm/v/@amagaki/amagaki-plugin-greenhouse.svg

[npm-url]: https://npmjs.org/package/@amagaki/amagaki-plugin-greenhouse

[gts-image]: https://img.shields.io/badge/code%20style-google-blueviolet.svg

[gts-url]: https://github.com/google/gts