- Notifications
You must be signed in to change notification settings - Fork3
This is unofficial NodeJs (JavaScript) API for ray.so that turns your code into beautiful images. Choose from a range of syntax colors, hide or show the background, and toggle between a dark and light window.
License
akashrchandran/rayso
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
This is unofficial NodeJs (JavaScript) API forray.so that turns your code into beautiful images. Choose from a range of syntax colors, hide or show the background, and toggle between a dark and light window.
Note
This is a fork of the projectrayso-api developed bys0ftik3, which is no longer maintained. I have updated the project to work with the latest version of the ray.so.
$ npm i rayso
importRaySofrom'rayso'constraySo=newRaySo({// parameters, if you want to customize the output// you'll find detailed info about parameters below})raySo.cook(`console.log('Hello, World!');`).then(response=>{// response is image buffer}).catch(err=>{console.error(err)})
importRaySofrom'rayso'constraySo=newRaySo()
| Parameter | Default value | Type | Description |
|---|---|---|---|
width | "" (auto-sized) | String or Number | Sets the image width in pixels. Accepts numbers (e.g.,700) or strings with digits (e.g.,"700"). Value must be between 520 and 920. Defaults to auto-sizing if omitted or empty. |
title | "Untitled-1" | String | The title will be displayed on top of the code box. |
theme | "breeze" | String | There are several options of how your box will look like. Available themes: breeze, candy, crimson, falcon, meadow, midnight, raindrop, sunset |
background | true | Boolean | If disabled, it will create an image of code box only, without background. |
darkMode | true | Boolean | If disabled, it will change your theme to its light version. |
padding | 32 | String or Number | Distance between borders and code box. Available values: 16, 32, 64 and 128. |
language | "auto" | String | You better leave it auto :/ However, you can try to pass some language name and if it worked, good for you! |
localPreview | false | Boolean | If enabled, it will create example.png image file of the output in the current directory. |
localPreviewPath | current directory | String | Path to create example files. MacOS, Linux and Windows paths supported. |
debug | false | Boolean | If enabled, it will show messages in the console during code execution. |
importRaySofrom'rayso'constraySo=newRaySo()
importRaySo,{CardTheme,CardPadding,CardProgrammingLanguage,}from'rayso'constraySo=newRaySo({width:750,title:'Custom Title',theme:CardTheme.CANDY,padding:CardPadding.md,language:CardProgrammingLanguage.JS,debug:true,localPreview:true,localPreviewPath:'/Users/akashrchandran/rayso_screenshots',})
importRaySofrom'rayso'constraySo=newRaySo({background:false})
These are all the available themes, so far. As soon Ray.So has a new theme, it will appear here. Default themebreeze is not listed here, you saw it in the first picture of this README.
importRaySofrom'rayso'constraySo=newRaySo({theme:'breeze'})
importRaySofrom'rayso'constraySo=newRaySo({theme:'mono'})
importRaySofrom'rayso'constraySo=newRaySo({theme:'candy'})
importRaySofrom'rayso'constraySo=newRaySo({theme:'crimson'})
importRaySofrom'rayso'constraySo=newRaySo({theme:'falcon'})
importRaySofrom'rayso'constraySo=newRaySo({theme:'meadow'})
importRaySofrom'rayso'constraySo=newRaySo({theme:'midnight'})
importRaySofrom'rayso'constraySo=newRaySo({theme:'raindrop'})
importRaySofrom'rayso'constraySo=newRaySo({theme:'sunset'})
Note
There are more themes available, please checkoption.js file to see the entire list.
About
This is unofficial NodeJs (JavaScript) API for ray.so that turns your code into beautiful images. Choose from a range of syntax colors, hide or show the background, and toggle between a dark and light window.
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Uh oh!
There was an error while loading.Please reload this page.
Contributors2
Uh oh!
There was an error while loading.Please reload this page.