Skip to content

Latest commit

 

History

History
36 lines (22 loc) · 1.1 KB

README.md

File metadata and controls

36 lines (22 loc) · 1.1 KB

Sahara

Super-simple API for converting SciolyFF files to HTML.

Deploy

Create your own instance on Heroku for free using the button above, or preview one here.

Usage

Send a POST request to <your heroku url>/api with the content of a SciolyFF file in the body. The following optional parameters are supported:

  • ?type={html,json}

    Change the response type. The JSON contains either the HTML or messages indicating why the SciolyFF input is not valid.

  • ?hide_raw={true,false}

    Replace the raw results in the input with just places in the SciolyFF file embeded in the generated HTML.

  • ?color={hex color}

    Changes the color of the background header in the generated HTML results.

Example

<your heroku url>/api?type=html&hide_raw=false&color=%23C92424

Alternatively, open <your heroku url>/ in a browser to experiment with SciolyFF in a playground, and view the page source to see an example of calling the API using Javascript.