Girobusan ยท IMP!

IMP! Helpers

This menu is created by helper headers-nav


Helpers are the scripts, which use new Helpers API for adding various types of content, not supported by regular markdown. Helpers may add static and/or interactive content in asynchronous way and enrich viewer experience. Some examples can be seen here.

This API allows building interactive content blocks, whcih may also provide meaningful content without JavaScript. Links to developer docs are at the end of this page.

How to enable helpers for your IMP!

Ensure, that you have the right IMP! version

Check if you have updated to IMP! version 0.4.2 or higher. File helpers.js must live in the same directory, where your IMP! file is.

Enable helpers in IMP! GUI

There is a checkbox at the lower part of the page, labeled "enable helpers". You must then save and reload your IMP! file.

Get the helper scripts

Previous step just enables the API. To use helpers, you must get some helper scripts. Good place to start is the git-helpers repo, the helpers folder there contains bundled scripts.

You'll need to create a folder, named helpers in the same directory, where your IMP! file is, and put required helpers there.

Use them in markdown

The full syntax for helper will look like this:

 ```helper:helper-name/helper-subtype
  helper parameters in YAML, JSON or some other
  format (consult helper doc)
 ```

Subtype may be omitted, word helper may be shortened to just h:

 ```h:helper-name
  helper parameters in YAML, JSON or some other
  format (consult helper doc)
 ```

Things to check

Make your own

There are two other documents on that: