Skip to content

Commit d45025d

Browse files
committed
update docs to 0.1.14
1 parent 36875e1 commit d45025d

Some content is hidden

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

43 files changed

+1125
-351
lines changed

bun.lockb

13.1 KB
Binary file not shown.

package.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,20 @@
1111
"format": "prettier --plugin prettier-plugin-astro --plugin prettier-plugin-svelte --write ."
1212
},
1313
"dependencies": {
14-
"@astrojs/starlight": "0.26.1",
14+
"@astrojs/starlight": "0.27.1",
1515
"@astrojs/svelte": "^5.7.0",
16-
"astro": "4.14.5",
16+
"astro": "4.15.6",
1717
"rehype-mathjax": "^6.0.0",
1818
"remark-math": "^6.0.0",
1919
"sharp": "^0.33.5",
20-
"starlight-links-validator": "^0.10.1",
20+
"starlight-links-validator": "^0.12.0",
2121
"starlight-site-graph": "0.0.13",
22-
"starlight-typedoc": "^0.15.0",
22+
"starlight-typedoc": "^0.16.0",
2323
"svelte": "5.0.0-next.210",
24-
"typedoc": "^0.26.6",
25-
"typedoc-plugin-markdown": "^4.2.6",
26-
"typedoc-plugin-mdn-links": "^3.2.10",
27-
"typescript": "^5.5.4"
24+
"typedoc": "^0.26.7",
25+
"typedoc-plugin-markdown": "^4.2.7",
26+
"typedoc-plugin-mdn-links": "^3.2.12",
27+
"typescript": "^5.6.2"
2828
},
2929
"devDependencies": {
3030
"prettier": "^3.3.3",

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

Lines changed: 17 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/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L45)
69+
[jsEngine/api/API.ts:45](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/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/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L17)
81+
[jsEngine/api/API.ts:17](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/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/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L22)
91+
[jsEngine/api/API.ts:22](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/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/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L43)
103+
[jsEngine/api/API.ts:43](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/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/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L34)
115+
[jsEngine/api/API.ts:34](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/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/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L26)
127+
[jsEngine/api/API.ts:26](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/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/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L30)
139+
[jsEngine/api/API.ts:30](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/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/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L21)
151+
[jsEngine/api/API.ts:21](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/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/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L39)
161+
[jsEngine/api/API.ts:39](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/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/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L38)
173+
[jsEngine/api/API.ts:38](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/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/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L80)
221+
[jsEngine/api/API.ts:85](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/jsEngine/api/API.ts#L85)
222222

223223
***
224224

@@ -227,6 +227,10 @@ the id of the plugin.
227227
> **importJs**(`path`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`unknown`\>
228228
229229
Loads an ECMAScript module from a vault relative path.
230+
Everything you import via this function will be loaded as an ECMAScript module.
231+
232+
Since imports are cached by the browser (aka Obsidian),
233+
you might need to reload Obsidian to see changes made to the imported file.
230234

231235
#### Parameters
232236

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

266270
#### Defined in
267271

268-
[jsEngine/api/API.ts:63](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/e96ff61292c9e90d57d921fab05d7cb5220aa91b/jsEngine/api/API.ts#L63)
272+
[jsEngine/api/API.ts:67](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/jsEngine/api/API.ts#L67)
269273

270274
***
271275

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

331335
#### Defined in
332336

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

0 commit comments

Comments
 (0)