Skip to content

Commit

Permalink
docs: update scripting section in the user manual
Browse files Browse the repository at this point in the history
  • Loading branch information
polyrainbow committed Dec 4, 2024
1 parent 72f8ec7 commit 155bd46
Showing 1 changed file with 31 additions and 2 deletions.
33 changes: 31 additions & 2 deletions public/docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -581,6 +581,23 @@ <h2>Scripting</h2>
Use with caution and be sure to backup your data beforehand.
</p>

<p>
The possibilities are endless but here are some example use cases:

<ul>
<li>
creating a list of red links (links to non-existing notes) and how
often they occur
</li>
<li>
creating a list of events based on dates mentioned in the note graph
</li>
<li>
creating a website with aggregated data from the note graph.
</li>
</ul>
</p>

<h3>Creating a script</h3>

<p>
Expand All @@ -590,10 +607,10 @@ <h3>Creating a script</h3>
in the files list. Click on it and then click on "Open in script editor".
</p>

<h3>Symbols</h3>
<h3>Variables</h3>

<p>
The following symbols are defined in the JavaScript environment:
The following variables are defined in the JavaScript environment:
</p>

<h4><code>notesProvider</code></h4>
Expand All @@ -606,6 +623,18 @@ <h4><code>notesProvider</code></h4>
Type: <code><a href="https://github.com/polyrainbow/neno/blob/main/src/lib/notes/index.ts#L55">NotesProvider</a></code>
</p>

<h4><code>storageProvider</code></h4>
<p>
A collection of functions for reading from and writing to the file system.
Operations are limited to the graph folder. Use this interface if you need
a low-level way of manipulating the graph or if you want to save
arbitrary files.
</p>

<p>
Type: <code><a href="https://github.com/polyrainbow/neno/blob/main/src/lib/notes/types/StorageProvider.ts#L3">StorageProvider</a></code>
</p>

<h4><code>graph</code></h4>
<p>
A representation of the currently loaded graph, including all notes,
Expand Down

0 comments on commit 155bd46

Please sign in to comment.