Skip to content

Commit 9f0f335

Browse files
mProjectsCodemProjectsCode
committed
update docs
1 parent a53cb7c commit 9f0f335

30 files changed

+264
-239
lines changed

‎docs/assets/search.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/classes/API.API.html‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
2121
<ul class="tsd-hierarchy">
2222
<li><span class="target">API</span></li></ul></section><aside class="tsd-sources">
2323
<ul>
24-
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/acb3d73/src/api/API.ts#L7">API.ts:7</a></li></ul></aside>
24+
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/a53cb7c/src/api/API.ts#L7">API.ts:7</a></li></ul></aside>
2525
<section class="tsd-panel-group tsd-index-group">
2626
<section class="tsd-panel tsd-index-panel">
2727
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -62,7 +62,7 @@ <h5><span class="tsd-kind-parameter">plugin</span>: <span class="tsd-signature-t
6262
<h5><span class="tsd-kind-parameter">instanceId</span>: <a href="InstanceId.InstanceId.html" class="tsd-signature-type tsd-kind-class">InstanceId</a></h5></li></ul></div>
6363
<h4 class="tsd-returns-title">Returns <a href="API.API.html" class="tsd-signature-type tsd-kind-class">API</a></h4><aside class="tsd-sources">
6464
<ul>
65-
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/acb3d73/src/api/API.ts#L26">API.ts:26</a></li></ul></aside></li></ul></section></section>
65+
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/a53cb7c/src/api/API.ts#L26">API.ts:26</a></li></ul></aside></li></ul></section></section>
6666
<section class="tsd-panel-group tsd-member-group">
6767
<h2>Properties</h2>
6868
<section class="tsd-panel tsd-member"><a id="app" class="tsd-anchor"></a>
@@ -72,36 +72,36 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code
7272
</div>
7373
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
7474
<ul>
75-
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/acb3d73/src/api/API.ts#L11">API.ts:11</a></li></ul></aside></section>
75+
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/a53cb7c/src/api/API.ts#L11">API.ts:11</a></li></ul></aside></section>
7676
<section class="tsd-panel tsd-member"><a id="instanceId" class="tsd-anchor"></a>
7777
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>instance<wbr/>Id</span><a href="#instanceId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
7878
<div class="tsd-signature"><span class="tsd-kind-property">instance<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <a href="InstanceId.InstanceId.html" class="tsd-signature-type tsd-kind-class">InstanceId</a></div><aside class="tsd-sources">
7979
<ul>
80-
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/acb3d73/src/api/API.ts#L16">API.ts:16</a></li></ul></aside></section>
80+
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/a53cb7c/src/api/API.ts#L16">API.ts:16</a></li></ul></aside></section>
8181
<section class="tsd-panel tsd-member"><a id="markdown" class="tsd-anchor"></a>
8282
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>markdown</span><a href="#markdown" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
8383
<div class="tsd-signature"><span class="tsd-kind-property">markdown</span><span class="tsd-signature-symbol">:</span> <a href="MarkdownAPI.MarkdownAPI.html" class="tsd-signature-type tsd-kind-class">MarkdownAPI</a></div>
8484
<div class="tsd-comment tsd-typography"><p>API to interact with markdown.</p>
8585
</div>
8686
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
8787
<ul>
88-
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/acb3d73/src/api/API.ts#L20">API.ts:20</a></li></ul></aside></section>
88+
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/a53cb7c/src/api/API.ts#L20">API.ts:20</a></li></ul></aside></section>
8989
<section class="tsd-panel tsd-member"><a id="message" class="tsd-anchor"></a>
9090
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
9191
<div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <a href="MessageAPI.MessageAPI.html" class="tsd-signature-type tsd-kind-class">MessageAPI</a></div>
9292
<div class="tsd-comment tsd-typography"><p>API to interact with the plugins message system.</p>
9393
</div>
9494
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
9595
<ul>
96-
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/acb3d73/src/api/API.ts#L24">API.ts:24</a></li></ul></aside></section>
96+
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/a53cb7c/src/api/API.ts#L24">API.ts:24</a></li></ul></aside></section>
9797
<section class="tsd-panel tsd-member"><a id="plugin" class="tsd-anchor"></a>
9898
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>plugin</span><a href="#plugin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
9999
<div class="tsd-signature"><span class="tsd-kind-property">plugin</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">default</span></div>
100100
<div class="tsd-comment tsd-typography"><p>Reference the JS Engine plugin.</p>
101101
</div>
102102
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
103103
<ul>
104-
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/acb3d73/src/api/API.ts#L15">API.ts:15</a></li></ul></aside></section></section>
104+
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/a53cb7c/src/api/API.ts#L15">API.ts:15</a></li></ul></aside></section></section>
105105
<section class="tsd-panel-group tsd-member-group">
106106
<h2>Methods</h2>
107107
<section class="tsd-panel tsd-member"><a id="getPlugin" class="tsd-anchor"></a>
@@ -122,7 +122,7 @@ <h5><span class="tsd-kind-parameter">pluginId</span>: <span class="tsd-signature
122122
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Plugin</span></h4>
123123
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
124124
<ul>
125-
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/acb3d73/src/api/API.ts#L50">API.ts:50</a></li></ul></aside></li></ul></section>
125+
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/a53cb7c/src/api/API.ts#L50">API.ts:50</a></li></ul></aside></li></ul></section>
126126
<section class="tsd-panel tsd-member"><a id="importJs" class="tsd-anchor"></a>
127127
<h3 class="tsd-anchor-link"><span>import<wbr/>Js</span><a href="#importJs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
128128
<ul class="tsd-signatures">
@@ -141,7 +141,7 @@ <h5><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-typ
141141
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
142142
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
143143
<ul>
144-
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/acb3d73/src/api/API.ts#L40">API.ts:40</a></li></ul></aside></li></ul></section></section></div>
144+
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/a53cb7c/src/api/API.ts#L40">API.ts:40</a></li></ul></aside></li></ul></section></section></div>
145145
<div class="col-sidebar">
146146
<div class="page-menu">
147147
<div class="tsd-navigation settings">

‎docs/classes/InstanceId.InstanceId.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ <h4>Hierarchy</h4>
2626
<ul class="tsd-hierarchy">
2727
<li><span class="target">InstanceId</span></li></ul></section><aside class="tsd-sources">
2828
<ul>
29-
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/acb3d73/src/api/InstanceId.ts#L11">InstanceId.ts:11</a></li></ul></aside>
29+
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/a53cb7c/src/api/InstanceId.ts#L11">InstanceId.ts:11</a></li></ul></aside>
3030
<section class="tsd-panel-group tsd-index-group">
3131
<section class="tsd-panel tsd-index-panel">
3232
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -61,19 +61,19 @@ <h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-typ
6161
<h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
6262
<h4 class="tsd-returns-title">Returns <a href="InstanceId.InstanceId.html" class="tsd-signature-type tsd-kind-class">InstanceId</a></h4><aside class="tsd-sources">
6363
<ul>
64-
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/acb3d73/src/api/InstanceId.ts#L15">InstanceId.ts:15</a></li></ul></aside></li></ul></section></section>
64+
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/a53cb7c/src/api/InstanceId.ts#L15">InstanceId.ts:15</a></li></ul></aside></li></ul></section></section>
6565
<section class="tsd-panel-group tsd-member-group">
6666
<h2>Properties</h2>
6767
<section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a>
6868
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
6969
<div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
7070
<ul>
71-
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/acb3d73/src/api/InstanceId.ts#L13">InstanceId.ts:13</a></li></ul></aside></section>
71+
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/a53cb7c/src/api/InstanceId.ts#L13">InstanceId.ts:13</a></li></ul></aside></section>
7272
<section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a>
7373
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
7474
<div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
7575
<ul>
76-
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/acb3d73/src/api/InstanceId.ts#L12">InstanceId.ts:12</a></li></ul></aside></section></section>
76+
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/a53cb7c/src/api/InstanceId.ts#L12">InstanceId.ts:12</a></li></ul></aside></section></section>
7777
<section class="tsd-panel-group tsd-member-group">
7878
<h2>Methods</h2>
7979
<section class="tsd-panel tsd-member"><a id="create" class="tsd-anchor"></a>
@@ -88,7 +88,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
8888
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
8989
<h4 class="tsd-returns-title">Returns <a href="InstanceId.InstanceId.html" class="tsd-signature-type tsd-kind-class">InstanceId</a></h4><aside class="tsd-sources">
9090
<ul>
91-
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/acb3d73/src/api/InstanceId.ts#L20">InstanceId.ts:20</a></li></ul></aside></li></ul></section></section></div>
91+
<li>Defined in <a href="https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/a53cb7c/src/api/InstanceId.ts#L20">InstanceId.ts:20</a></li></ul></aside></li></ul></section></section></div>
9292
<div class="col-sidebar">
9393
<div class="page-menu">
9494
<div class="tsd-navigation settings">

0 commit comments

Comments
 (0)