update docs and prep for deploy

Author: mProjectsCode

.github/workflows/deploy.yml

@@ -0,0 +1,36 @@
+name: Deploy to GitHub Pages
+
+on:
+  # Allows you to run this workflow manually from the Actions tab on GitHub.
+  workflow_dispatch:
+
+# Allow this job to clone the repo and create a page deployment
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout your repository using git
+        uses: actions/checkout@v3
+      - name: Install, build, and upload your site
+        uses:
+          withastro/action@v1
+          # with:
+          # path: . # The root location of your Astro project inside the repository. (optional)
+          # node-version: 18 # The specific version of Node that should be used to build your site. Defaults to 18. (optional)
+        # package-manager: pnpm@latest # The Node package manager that should be used to install dependencies and build your site. Automatically detected based on your lockfile. (optional)
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

astro.config.mjs

@@ -25,6 +25,10 @@ export default defineConfig({
 				},
 				typeDocSidebarGroup,
 			],
+			expressiveCode: {
+				themes: ['dracula', 'github-light'],
+				useStarlightUiThemeColors: true,
+			},
 			plugins: [
 				starlightTypeDoc({
 					entryPoints: [

obsidian-js-engine-plugin

@@ -30,7 +30,7 @@ new API(
 
 #### Source
 
-[jsEngine/api/API.ts:38](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/API.ts#L38)
+[jsEngine/api/API.ts:38](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/API.ts#L38)
 
 ## Methods
 
@@ -54,7 +54,7 @@ Gets a plugin by its id. A plugin id can be found by looking at its manifest.
 
 #### Source
 
-[jsEngine/api/API.ts:70](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/API.ts#L70)
+[jsEngine/api/API.ts:70](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/API.ts#L70)
 
 ***
 
@@ -78,7 +78,7 @@ Loads an ECMAScript module from a vault relative path.
 
 #### Source
 
-[jsEngine/api/API.ts:54](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/API.ts#L54)
+[jsEngine/api/API.ts:54](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/API.ts#L54)
 
 ***
 
@@ -104,7 +104,7 @@ Reactive components are useful for creating dynamic content.
 
 #### Source
 
-[jsEngine/api/API.ts:81](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/API.ts#L81)
+[jsEngine/api/API.ts:81](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/API.ts#L81)
 
 ## Properties
 
@@ -118,7 +118,7 @@ Reference to the obsidian app.
 
 #### Source
 
-[jsEngine/api/API.ts:15](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/API.ts#L15)
+[jsEngine/api/API.ts:15](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/API.ts#L15)
 
 ***
 
@@ -130,7 +130,7 @@ readonly instanceId: InstanceId;
 
 #### Source
 
-[jsEngine/api/API.ts:20](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/API.ts#L20)
+[jsEngine/api/API.ts:20](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/API.ts#L20)
 
 ***
 
@@ -144,7 +144,7 @@ API to interact with js engines internals.
 
 #### Source
 
-[jsEngine/api/API.ts:36](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/API.ts#L36)
+[jsEngine/api/API.ts:36](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/API.ts#L36)
 
 ***
 
@@ -158,7 +158,7 @@ API to interact with packaged libraries.
 
 #### Source
 
-[jsEngine/api/API.ts:32](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/API.ts#L32)
+[jsEngine/api/API.ts:32](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/API.ts#L32)
 
 ***
 
@@ -172,7 +172,7 @@ API to interact with markdown.
 
 #### Source
 
-[jsEngine/api/API.ts:24](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/API.ts#L24)
+[jsEngine/api/API.ts:24](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/API.ts#L24)
 
 ***
 
@@ -186,7 +186,7 @@ API to interact with the plugins message system.
 
 #### Source
 
-[jsEngine/api/API.ts:28](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/API.ts#L28)
+[jsEngine/api/API.ts:28](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/API.ts#L28)
 
 ***
 
@@ -200,7 +200,7 @@ Reference the JS Engine plugin.
 
 #### Source
 
-[jsEngine/api/API.ts:19](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/API.ts#L19)
+[jsEngine/api/API.ts:19](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/API.ts#L19)
 
 ***
 

src/content/docs/api/api/API/classes/API.md

@@ -27,7 +27,7 @@ new InternalAPI(apiInstance): InternalAPI
 
 #### Source
 
-[jsEngine/api/Internal.ts:13](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/Internal.ts#L13)
+[jsEngine/api/Internal.ts:13](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/Internal.ts#L13)
 
 ## Methods
 
@@ -56,7 +56,7 @@ Creates a result renderer.
 
 #### Source
 
-[jsEngine/api/Internal.ts:33](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/Internal.ts#L33)
+[jsEngine/api/Internal.ts:33](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/Internal.ts#L33)
 
 ***
 
@@ -80,7 +80,7 @@ Executes the given code.
 
 #### Source
 
-[jsEngine/api/Internal.ts:22](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/Internal.ts#L22)
+[jsEngine/api/Internal.ts:22](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/Internal.ts#L22)
 
 ***
 
@@ -105,7 +105,7 @@ Load and execute the given file.
 
 #### Source
 
-[jsEngine/api/Internal.ts:43](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/Internal.ts#L43)
+[jsEngine/api/Internal.ts:43](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/Internal.ts#L43)
 
 ***
 

src/content/docs/api/api/Internal/classes/InternalAPI.md

@@ -27,7 +27,7 @@ new LibAPI(apiInstance): LibAPI
 
 #### Source
 
-[jsEngine/api/LibAPI.ts:24](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/LibAPI.ts#L24)
+[jsEngine/api/LibAPI.ts:24](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/LibAPI.ts#L24)
 
 ## Methods
 
@@ -45,7 +45,7 @@ Get the [itertools-ts](https://github.com/Smoren/itertools-ts) library.
 
 #### Source
 
-[jsEngine/api/LibAPI.ts:45](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/LibAPI.ts#L45)
+[jsEngine/api/LibAPI.ts:45](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/LibAPI.ts#L45)
 
 ***
 
@@ -63,7 +63,7 @@ Get the [ParsiNOM](https://github.com/mProjectsCode/parsiNOM) library.
 
 #### Source
 
-[jsEngine/api/LibAPI.ts:31](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/LibAPI.ts#L31)
+[jsEngine/api/LibAPI.ts:31](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/LibAPI.ts#L31)
 
 ***
 

src/content/docs/api/api/LibAPI/classes/LibAPI.md

@@ -15,7 +15,7 @@ P: *typeof* P;
 
 #### Source
 
-[jsEngine/api/LibAPI.ts:10](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/LibAPI.ts#L10)
+[jsEngine/api/LibAPI.ts:10](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/LibAPI.ts#L10)
 
 ***
 
@@ -27,7 +27,7 @@ P_UTILS: *typeof* P_UTILS;
 
 #### Source
 
-[jsEngine/api/LibAPI.ts:11](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/LibAPI.ts#L11)
+[jsEngine/api/LibAPI.ts:11](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/LibAPI.ts#L11)
 
 ***
 
@@ -39,7 +39,7 @@ Parser: *typeof* Parser;
 
 #### Source
 
-[jsEngine/api/LibAPI.ts:12](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/LibAPI.ts#L12)
+[jsEngine/api/LibAPI.ts:12](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/LibAPI.ts#L12)
 
 ***
 
@@ -51,7 +51,7 @@ ParserContext: *typeof* ParserContext;
 
 #### Source
 
-[jsEngine/api/LibAPI.ts:15](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/LibAPI.ts#L15)
+[jsEngine/api/LibAPI.ts:15](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/LibAPI.ts#L15)
 
 ***
 
@@ -63,7 +63,7 @@ ParsingError: *typeof* ParsingError;
 
 #### Source
 
-[jsEngine/api/LibAPI.ts:14](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/LibAPI.ts#L14)
+[jsEngine/api/LibAPI.ts:14](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/LibAPI.ts#L14)
 
 ***
 
@@ -89,7 +89,7 @@ Generate an error message string for a parse failure on a specific string.
 
 #### Source
 
-[jsEngine/api/LibAPI.ts:13](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/LibAPI.ts#L13)
+[jsEngine/api/LibAPI.ts:13](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/LibAPI.ts#L13)
 
 ***
 

src/content/docs/api/api/LibAPI/interfaces/LibParsiNOM.md

@@ -27,7 +27,7 @@ new MarkdownAPI(apiInstance): MarkdownAPI
 
 #### Source
 
-[jsEngine/api/MarkdownAPI.ts:21](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/MarkdownAPI.ts#L21)
+[jsEngine/api/MarkdownAPI.ts:21](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/MarkdownAPI.ts#L21)
 
 ## Methods
 
@@ -53,7 +53,7 @@ It only wraps it in an object, so that the plugin can recognize and render it as
 
 #### Source
 
-[jsEngine/api/MarkdownAPI.ts:39](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/MarkdownAPI.ts#L39)
+[jsEngine/api/MarkdownAPI.ts:39](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/MarkdownAPI.ts#L39)
 
 ***
 
@@ -71,7 +71,7 @@ Creates a new markdown block quote element.
 
 #### Source
 
-[jsEngine/api/MarkdownAPI.ts:110](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/MarkdownAPI.ts#L110)
+[jsEngine/api/MarkdownAPI.ts:110](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/MarkdownAPI.ts#L110)
 
 ***
 
@@ -95,7 +95,7 @@ Creates a new markdown text element with bold formatting.
 
 #### Source
 
-[jsEngine/api/MarkdownAPI.ts:57](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/MarkdownAPI.ts#L57)
+[jsEngine/api/MarkdownAPI.ts:57](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/MarkdownAPI.ts#L57)
 
 ***
 
@@ -113,7 +113,7 @@ Creates a markdown builder.
 
 #### Source
 
-[jsEngine/api/MarkdownAPI.ts:28](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/MarkdownAPI.ts#L28)
+[jsEngine/api/MarkdownAPI.ts:28](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/MarkdownAPI.ts#L28)
 
 ***
 
@@ -142,7 +142,7 @@ Creates a new markdown callout element.
 
 #### Source
 
-[jsEngine/api/MarkdownAPI.ts:121](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/MarkdownAPI.ts#L121)
+[jsEngine/api/MarkdownAPI.ts:121](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/MarkdownAPI.ts#L121)
 
 ***
 
@@ -166,7 +166,7 @@ Creates a new markdown code element.
 
 #### Source
 
-[jsEngine/api/MarkdownAPI.ts:84](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/MarkdownAPI.ts#L84)
+[jsEngine/api/MarkdownAPI.ts:84](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/MarkdownAPI.ts#L84)
 
 ***
 
@@ -191,7 +191,7 @@ Creates a new markdown code block element.
 
 #### Source
 
-[jsEngine/api/MarkdownAPI.ts:131](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/MarkdownAPI.ts#L131)
+[jsEngine/api/MarkdownAPI.ts:131](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/MarkdownAPI.ts#L131)
 
 ***
 
@@ -215,7 +215,7 @@ Creates a new markdown text element with cursive formatting.
 
 #### Source
 
-[jsEngine/api/MarkdownAPI.ts:66](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/MarkdownAPI.ts#L66)
+[jsEngine/api/MarkdownAPI.ts:66](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/MarkdownAPI.ts#L66)
 
 ***
 
@@ -240,7 +240,7 @@ Creates a new markdown heading element.
 
 #### Source
 
-[jsEngine/api/MarkdownAPI.ts:103](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/MarkdownAPI.ts#L103)
+[jsEngine/api/MarkdownAPI.ts:103](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/MarkdownAPI.ts#L103)
 
 ***
 
@@ -264,7 +264,7 @@ Creates a new markdown paragraph element.
 
 #### Source
 
-[jsEngine/api/MarkdownAPI.ts:93](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/MarkdownAPI.ts#L93)
+[jsEngine/api/MarkdownAPI.ts:93](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/MarkdownAPI.ts#L93)
 
 ***
 
@@ -289,7 +289,7 @@ Creates a new markdown table element.
 
 #### Source
 
-[jsEngine/api/MarkdownAPI.ts:141](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/MarkdownAPI.ts#L141)
+[jsEngine/api/MarkdownAPI.ts:141](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/MarkdownAPI.ts#L141)
 
 ***
 
@@ -313,7 +313,7 @@ Creates a new markdown text element.
 
 #### Source
 
-[jsEngine/api/MarkdownAPI.ts:48](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/MarkdownAPI.ts#L48)
+[jsEngine/api/MarkdownAPI.ts:48](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/MarkdownAPI.ts#L48)
 
 ***
 
@@ -337,7 +337,7 @@ Creates a new markdown text element with underline formatting.
 
 #### Source
 
-[jsEngine/api/MarkdownAPI.ts:75](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/0278a4c/jsEngine/api/MarkdownAPI.ts#L75)
+[jsEngine/api/MarkdownAPI.ts:75](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b447776/jsEngine/api/MarkdownAPI.ts#L75)
 
 ***