Skip to content

Commit 36875e1

Browse files
committed
update docs
1 parent a9ccec1 commit 36875e1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+491
-293
lines changed

bun.lockb

2.29 KB
Binary file not shown.

package.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,17 @@
1313
"dependencies": {
1414
"@astrojs/starlight": "0.26.1",
1515
"@astrojs/svelte": "^5.7.0",
16-
"astro": "4.14.2",
16+
"astro": "4.14.5",
1717
"rehype-mathjax": "^6.0.0",
1818
"remark-math": "^6.0.0",
1919
"sharp": "^0.33.5",
20-
"starlight-links-validator": "^0.9.1",
20+
"starlight-links-validator": "^0.10.1",
2121
"starlight-site-graph": "0.0.13",
22-
"starlight-typedoc": "^0.14.0",
22+
"starlight-typedoc": "^0.15.0",
2323
"svelte": "5.0.0-next.210",
2424
"typedoc": "^0.26.6",
25-
"typedoc-plugin-markdown": "^4.2.5",
26-
"typedoc-plugin-mdn-links": "^3.2.9",
25+
"typedoc-plugin-markdown": "^4.2.6",
26+
"typedoc-plugin-mdn-links": "^3.2.10",
2727
"typescript": "^5.5.4"
2828
},
2929
"devDependencies": {

src/content/docs/api/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,11 @@ title: "obsidian-js-engine-plugin"
4444
- [InputPromptOptions](/obsidian-js-engine-plugin-docs/api/interfaces/inputpromptoptions/)
4545
- [JsExecutionContext](/obsidian-js-engine-plugin-docs/api/interfaces/jsexecutioncontext/)
4646
- [JsExecutionGlobals](/obsidian-js-engine-plugin-docs/api/interfaces/jsexecutionglobals/)
47+
- [JsExecutionGlobalsConstructionOptions](/obsidian-js-engine-plugin-docs/api/interfaces/jsexecutionglobalsconstructionoptions/)
4748
- [JsExecutionParams](/obsidian-js-engine-plugin-docs/api/interfaces/jsexecutionparams/)
4849
- [LibParsiNOM](/obsidian-js-engine-plugin-docs/api/interfaces/libparsinom/)
4950
- [ModalPromptOptions](/obsidian-js-engine-plugin-docs/api/interfaces/modalpromptoptions/)
51+
- [NumberInputPromptOptions](/obsidian-js-engine-plugin-docs/api/interfaces/numberinputpromptoptions/)
5052
- [SuggesterOption](/obsidian-js-engine-plugin-docs/api/interfaces/suggesteroption/)
5153
- [SuggesterPromptOptions](/obsidian-js-engine-plugin-docs/api/interfaces/suggesterpromptoptions/)
5254
- [YesNoPromptOptions](/obsidian-js-engine-plugin-docs/api/interfaces/yesnopromptoptions/)

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ title: "API"
6666

6767
#### Defined in
6868

69-
[jsEngine/api/API.ts:45](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/API.ts#L45)
69+
[jsEngine/api/API.ts:45](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L45)
7070

7171
## Properties
7272

@@ -78,7 +78,7 @@ Reference to the obsidian app.
7878

7979
#### Defined in
8080

81-
[jsEngine/api/API.ts:17](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/API.ts#L17)
81+
[jsEngine/api/API.ts:17](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L17)
8282

8383
***
8484

@@ -88,7 +88,7 @@ Reference to the obsidian app.
8888
8989
#### Defined in
9090

91-
[jsEngine/api/API.ts:22](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/API.ts#L22)
91+
[jsEngine/api/API.ts:22](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L22)
9292

9393
***
9494

@@ -100,7 +100,7 @@ API to interact with js engines internals.
100100

101101
#### Defined in
102102

103-
[jsEngine/api/API.ts:43](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/API.ts#L43)
103+
[jsEngine/api/API.ts:43](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L43)
104104

105105
***
106106

@@ -112,7 +112,7 @@ API to interact with packaged libraries.
112112

113113
#### Defined in
114114

115-
[jsEngine/api/API.ts:34](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/API.ts#L34)
115+
[jsEngine/api/API.ts:34](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L34)
116116

117117
***
118118

@@ -124,7 +124,7 @@ API to interact with markdown.
124124

125125
#### Defined in
126126

127-
[jsEngine/api/API.ts:26](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/API.ts#L26)
127+
[jsEngine/api/API.ts:26](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L26)
128128

129129
***
130130

@@ -136,7 +136,7 @@ API to interact with the plugins message system.
136136

137137
#### Defined in
138138

139-
[jsEngine/api/API.ts:30](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/API.ts#L30)
139+
[jsEngine/api/API.ts:30](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L30)
140140

141141
***
142142

@@ -148,7 +148,7 @@ Reference the JS Engine plugin.
148148

149149
#### Defined in
150150

151-
[jsEngine/api/API.ts:21](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/API.ts#L21)
151+
[jsEngine/api/API.ts:21](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L21)
152152

153153
***
154154

@@ -158,7 +158,7 @@ Reference the JS Engine plugin.
158158
159159
#### Defined in
160160

161-
[jsEngine/api/API.ts:39](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/API.ts#L39)
161+
[jsEngine/api/API.ts:39](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L39)
162162

163163
***
164164

@@ -170,7 +170,7 @@ API to query your vault with simple javascript functions.
170170

171171
#### Defined in
172172

173-
[jsEngine/api/API.ts:38](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/API.ts#L38)
173+
[jsEngine/api/API.ts:38](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L38)
174174

175175
## Methods
176176

@@ -218,7 +218,7 @@ the id of the plugin.
218218

219219
#### Defined in
220220

221-
[jsEngine/api/API.ts:80](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/API.ts#L80)
221+
[jsEngine/api/API.ts:80](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L80)
222222

223223
***
224224

@@ -265,7 +265,7 @@ the vault relative path of the file to import
265265

266266
#### Defined in
267267

268-
[jsEngine/api/API.ts:63](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/API.ts#L63)
268+
[jsEngine/api/API.ts:63](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L63)
269269

270270
***
271271

@@ -330,4 +330,4 @@ the initial arguments (for the first render) to pass to the function.
330330

331331
#### Defined in
332332

333-
[jsEngine/api/API.ts:91](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/API.ts#L91)
333+
[jsEngine/api/API.ts:91](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L91)

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

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Represents a markdown block quote.
2727

2828
#### Defined in
2929

30-
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:11](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L11)
30+
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:11](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L11)
3131

3232
## Properties
3333

@@ -41,7 +41,7 @@ Represents a markdown block quote.
4141

4242
#### Defined in
4343

44-
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:9](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L9)
44+
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:9](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L9)
4545

4646
## Methods
4747

@@ -84,7 +84,7 @@ Represents a markdown block quote.
8484

8585
#### Defined in
8686

87-
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:46](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L46)
87+
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:46](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L46)
8888

8989
***
9090

@@ -127,7 +127,7 @@ Represents a markdown block quote.
127127

128128
#### Defined in
129129

130-
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:64](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L64)
130+
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:64](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L64)
131131

132132
***
133133

@@ -170,7 +170,7 @@ Represents a markdown block quote.
170170

171171
#### Defined in
172172

173-
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:52](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L52)
173+
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:52](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L52)
174174

175175
***
176176

@@ -223,7 +223,7 @@ Error if the element is not allowed in the container.
223223

224224
#### Defined in
225225

226-
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:32](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L32)
226+
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:32](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L32)
227227

228228
***
229229

@@ -266,7 +266,7 @@ Error if the element is not allowed in the container.
266266

267267
#### Defined in
268268

269-
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:40](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L40)
269+
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:40](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L40)
270270

271271
***
272272

@@ -309,7 +309,7 @@ Error if the element is not allowed in the container.
309309

310310
#### Defined in
311311

312-
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:58](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L58)
312+
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:58](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L58)
313313

314314
***
315315

@@ -327,7 +327,7 @@ Error if the element is not allowed in the container.
327327

328328
#### Defined in
329329

330-
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:82](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L82)
330+
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:82](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L82)
331331

332332
***
333333

@@ -410,7 +410,7 @@ Error if the element is not allowed in the container.
410410

411411
#### Defined in
412412

413-
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:88](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L88)
413+
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:88](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L88)
414414

415415
***
416416

@@ -465,7 +465,7 @@ Error if the element is not allowed in the container.
465465

466466
#### Defined in
467467

468-
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:94](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L94)
468+
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:94](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L94)
469469

470470
***
471471

@@ -520,7 +520,7 @@ Error if the element is not allowed in the container.
520520

521521
#### Defined in
522522

523-
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:76](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L76)
523+
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:76](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L76)
524524

525525
***
526526

@@ -563,7 +563,7 @@ Error if the element is not allowed in the container.
563563

564564
#### Defined in
565565

566-
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:106](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L106)
566+
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:106](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L106)
567567

568568
***
569569

@@ -606,7 +606,7 @@ Error if the element is not allowed in the container.
606606

607607
#### Defined in
608608

609-
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:70](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L70)
609+
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:70](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L70)
610610

611611
***
612612

@@ -661,7 +661,7 @@ Error if the element is not allowed in the container.
661661

662662
#### Defined in
663663

664-
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:100](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L100)
664+
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:100](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L100)
665665

666666
***
667667

@@ -681,7 +681,7 @@ Converts the element to a [MarkdownString](../../../../../obsidian-js-engine-plu
681681

682682
#### Defined in
683683

684-
[jsEngine/api/markdown/AbstractMarkdownElement.ts:21](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/markdown/AbstractMarkdownElement.ts#L21)
684+
[jsEngine/api/markdown/AbstractMarkdownElement.ts:21](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/markdown/AbstractMarkdownElement.ts#L21)
685685

686686
***
687687

@@ -701,4 +701,4 @@ Converts the element to a string.
701701

702702
#### Defined in
703703

704-
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:329](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/b03cdc5d89f9f492e8ccbc5d6a798fe7e18efd5e/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L329)
704+
[jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:329](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/markdown/AbstractMarkdownElementContainer.ts#L329)

0 commit comments

Comments
 (0)