Skip to content

Commit e75a8b1

Browse files
committed
update readme
1 parent dd13260 commit e75a8b1

File tree

1 file changed

+4
-13
lines changed

1 file changed

+4
-13
lines changed

README.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,13 @@ This plugin for Obsidian allows you to run JavaScript from within your notes usi
44

55
## Usage
66

7-
Start by creating a code block with the `js-engine` plugin. Inside the code block you can write any JS code and at the end return a value.
8-
The plugin will then render the returned value instead of the code block. When you return nothing, the plugin will not render anything and the code block will be invisible.
7+
Start by creating a code block with the `js-engine` plugin.
8+
Inside the code block you can write what ever JavaScript code that you want.
9+
The plugin will run the JavaScript and render the returned value in place of the code block.
910

1011
## API Docs
1112

12-
The following variables are available in the code blocks.
13-
14-
| Name | Type |
15-
| --------- | ----------------------------------------------- |
16-
| app | `App` (Obsidian) |
17-
| engine | `API` (this plugin) |
18-
| context | `ExecutionContext` (this plugin) or `undefined` |
19-
| component | `Component` (Obsidian) |
20-
| container | `HTMLElement` |
21-
22-
Documentation for the API and types that are available inside the code block can be found [here](https://mprojectscode.github.io/obsidian-js-engine-plugin/classes/API.API.html).
13+
Docs are available [here](https://www.moritzjung.dev/obsidian-js-engine-plugin-docs/).
2314

2415
## Examples
2516

0 commit comments

Comments
 (0)