Skip to content

Commit d0a12c9

Browse files
committed
update docs
1 parent f6f1bb0 commit d0a12c9

File tree

84 files changed

+2189
-1002
lines changed

Some content is hidden

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

84 files changed

+2189
-1002
lines changed

astro.config.mjs

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -104,28 +104,28 @@ export default defineConfig({
104104
collapsed: false,
105105
},
106106
}),
107-
starlightSiteGraph({
108-
graphConfig: {
109-
depth: 5,
110-
visibilityRules: ['!**/api/README.md', '*/api/**'],
111-
},
112-
trackVisitedPages: 'disable',
113-
storageLocation: 'none',
114-
sitemapConfig: {
115-
contentRoot: './src/content/docs',
116-
pageInclusionRules: ['!**/api/README.md', '**/api/**'],
117-
},
118-
// graphConfig: {
119-
// depth: 5,
120-
// trackVisitedPages: false,
121-
// },
122-
// storageLocation: 'none',
123-
// contentRoot: './src/content/docs',
124-
// include_sitemap: ['./api/*/**/*.md'],
125-
// exclude_sitemap: ['**'],
126-
// show_graph: ['api/**'],
127-
// hide_graph: ['**', ''],
128-
}),
107+
// starlightSiteGraph({
108+
// graphConfig: {
109+
// depth: 5,
110+
// visibilityRules: ['!**/api/README.md', '*/api/**'],
111+
// },
112+
// trackVisitedPages: 'disable',
113+
// storageLocation: 'none',
114+
// sitemapConfig: {
115+
// contentRoot: './src/content/docs',
116+
// pageInclusionRules: ['!**/api/README.md', '**/api/**'],
117+
// },
118+
// // graphConfig: {
119+
// // depth: 5,
120+
// // trackVisitedPages: false,
121+
// // },
122+
// // storageLocation: 'none',
123+
// // contentRoot: './src/content/docs',
124+
// // include_sitemap: ['./api/*/**/*.md'],
125+
// // exclude_sitemap: ['**'],
126+
// // show_graph: ['api/**'],
127+
// // hide_graph: ['**', ''],
128+
// }),
129129
],
130130
}),
131131
],

bun.lock

Lines changed: 1178 additions & 0 deletions
Large diffs are not rendered by default.

bun.lockb

-264 KB
Binary file not shown.

obsidian-meta-bind-plugin

package.json

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,19 @@
1111
"format": "prettier --plugin prettier-plugin-astro --plugin prettier-plugin-svelte --write ."
1212
},
1313
"dependencies": {
14-
"@astrojs/starlight": "0.29.0",
15-
"astro": "4.16.13",
16-
"starlight-links-validator": "^0.13.2",
17-
"starlight-site-graph": "^0.1.9",
18-
"starlight-typedoc": "^0.17.0",
19-
"typedoc": "^0.26.11",
20-
"typedoc-plugin-markdown": "^4.2.10",
21-
"typedoc-plugin-mdn-links": "^3.3.8",
22-
"typescript": "^5.6.3"
14+
"@astrojs/starlight": "0.31.1",
15+
"astro": "5.1.9",
16+
"starlight-links-validator": "^0.14.1",
17+
"starlight-site-graph": "^0.2.2",
18+
"starlight-typedoc": "^0.18.0",
19+
"typedoc": "^0.27.6",
20+
"typedoc-plugin-markdown": "^4.4.1",
21+
"typedoc-plugin-mdn-links": "^4.0.9",
22+
"typescript": "^5.7.3"
2323
},
2424
"devDependencies": {
25-
"prettier": "^3.3.3",
25+
"prettier": "^3.4.2",
2626
"prettier-plugin-astro": "^0.14.1",
27-
"prettier-plugin-svelte": "^3.2.8"
27+
"prettier-plugin-svelte": "^3.3.3"
2828
}
2929
}

src/content.config.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import { defineCollection } from 'astro:content';
2+
import { docsSchema } from '@astrojs/starlight/schema';
3+
import { docsLoader } from '@astrojs/starlight/loaders';
4+
5+
export const collections = {
6+
docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }),
7+
};

src/content/config.ts

Lines changed: 0 additions & 7 deletions
This file was deleted.

src/content/docs/api/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ title: "meta-bind-obsidian"
99

1010
- [BindTargetStorageType](/obsidian-meta-bind-plugin-docs/api/enumerations/bindtargetstoragetype/)
1111
- [ButtonActionType](/obsidian-meta-bind-plugin-docs/api/enumerations/buttonactiontype/)
12+
- [ButtonClickType](/obsidian-meta-bind-plugin-docs/api/enumerations/buttonclicktype/)
1213
- [ButtonStyleType](/obsidian-meta-bind-plugin-docs/api/enumerations/buttonstyletype/)
1314
- [FieldType](/obsidian-meta-bind-plugin-docs/api/enumerations/fieldtype/)
1415
- [InputFieldArgumentType](/obsidian-meta-bind-plugin-docs/api/enumerations/inputfieldargumenttype/)
@@ -27,6 +28,8 @@ title: "meta-bind-obsidian"
2728
## Interfaces
2829

2930
- [BindTargetDeclaration](/obsidian-meta-bind-plugin-docs/api/interfaces/bindtargetdeclaration/)
31+
- [ButtonActionMap](/obsidian-meta-bind-plugin-docs/api/interfaces/buttonactionmap/)
32+
- [ButtonClickContext](/obsidian-meta-bind-plugin-docs/api/interfaces/buttonclickcontext/)
3033
- [ButtonConfig](/obsidian-meta-bind-plugin-docs/api/interfaces/buttonconfig/)
3134
- [ButtonContext](/obsidian-meta-bind-plugin-docs/api/interfaces/buttoncontext/)
3235
- [ButtonDeclaration](/obsidian-meta-bind-plugin-docs/api/interfaces/buttondeclaration/)
@@ -39,7 +42,7 @@ title: "meta-bind-obsidian"
3942
- [EmbedOptions](/obsidian-meta-bind-plugin-docs/api/interfaces/embedoptions/)
4043
- [FieldDeclaration](/obsidian-meta-bind-plugin-docs/api/interfaces/fielddeclaration/)
4144
- [FieldOptionMap](/obsidian-meta-bind-plugin-docs/api/interfaces/fieldoptionmap/)
42-
- [InlineJsButtonAction](/obsidian-meta-bind-plugin-docs/api/interfaces/inlinejsbuttonaction/)
45+
- [InlineJSButtonAction](/obsidian-meta-bind-plugin-docs/api/interfaces/inlinejsbuttonaction/)
4346
- [InputButtonAction](/obsidian-meta-bind-plugin-docs/api/interfaces/inputbuttonaction/)
4447
- [InputFieldDeclaration](/obsidian-meta-bind-plugin-docs/api/interfaces/inputfielddeclaration/)
4548
- [InputFieldOptions](/obsidian-meta-bind-plugin-docs/api/interfaces/inputfieldoptions/)
@@ -56,6 +59,7 @@ title: "meta-bind-obsidian"
5659
- [RegexpReplaceInNoteButtonAction](/obsidian-meta-bind-plugin-docs/api/interfaces/regexpreplaceinnotebuttonaction/)
5760
- [ReplaceInNoteButtonAction](/obsidian-meta-bind-plugin-docs/api/interfaces/replaceinnotebuttonaction/)
5861
- [ReplaceSelfButtonAction](/obsidian-meta-bind-plugin-docs/api/interfaces/replaceselfbuttonaction/)
62+
- [RunTemplaterFileButtonAction](/obsidian-meta-bind-plugin-docs/api/interfaces/runtemplaterfilebuttonaction/)
5963
- [SimpleButtonGroupDeclaration](/obsidian-meta-bind-plugin-docs/api/interfaces/simplebuttongroupdeclaration/)
6064
- [SimpleFieldArgument](/obsidian-meta-bind-plugin-docs/api/interfaces/simplefieldargument/)
6165
- [SimpleInputFieldDeclaration](/obsidian-meta-bind-plugin-docs/api/interfaces/simpleinputfielddeclaration/)

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

Lines changed: 19 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ prev: false
55
title: "FieldMountable"
66
---
77

8+
Defined in: [packages/core/src/fields/FieldMountable.ts:4](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/43804cae2c305431d6768245a6348f2ee7f14fca/packages/core/src/fields/FieldMountable.ts#L4)
9+
810
## Extends
911

1012
- [`Mountable`](/obsidian-meta-bind-plugin-docs/api/classes/mountable/)
@@ -15,6 +17,8 @@ title: "FieldMountable"
1517

1618
> **new FieldMountable**(`plugin`, `uuid`, `filePath`): [`FieldMountable`](/obsidian-meta-bind-plugin-docs/api/classes/fieldmountable/)
1719
20+
Defined in: [packages/core/src/fields/FieldMountable.ts:9](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/43804cae2c305431d6768245a6348f2ee7f14fca/packages/core/src/fields/FieldMountable.ts#L9)
21+
1822
#### Parameters
1923

2024
<table>
@@ -72,40 +76,34 @@ title: "FieldMountable"
7276

7377
[`Mountable`](/obsidian-meta-bind-plugin-docs/api/classes/mountable/).[`constructor`](/obsidian-meta-bind-plugin-docs/api/classes/mountable/#constructors)
7478

75-
#### Defined in
76-
77-
[packages/core/src/fields/FieldMountable.ts:9](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/f797e384bc51b3b69ee936c1c8f585862087d6d3/packages/core/src/fields/FieldMountable.ts#L9)
78-
7979
## Properties
8080

8181
### plugin
8282

8383
> `readonly` **plugin**: `IPlugin`
8484
85-
#### Defined in
86-
87-
[packages/core/src/fields/FieldMountable.ts:5](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/f797e384bc51b3b69ee936c1c8f585862087d6d3/packages/core/src/fields/FieldMountable.ts#L5)
85+
Defined in: [packages/core/src/fields/FieldMountable.ts:5](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/43804cae2c305431d6768245a6348f2ee7f14fca/packages/core/src/fields/FieldMountable.ts#L5)
8886

8987
## Methods
9088

9189
### getFilePath()
9290

9391
> **getFilePath**(): `string`
9492
93+
Defined in: [packages/core/src/fields/FieldMountable.ts:21](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/43804cae2c305431d6768245a6348f2ee7f14fca/packages/core/src/fields/FieldMountable.ts#L21)
94+
9595
#### Returns
9696

9797
`string`
9898

99-
#### Defined in
100-
101-
[packages/core/src/fields/FieldMountable.ts:21](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/f797e384bc51b3b69ee936c1c8f585862087d6d3/packages/core/src/fields/FieldMountable.ts#L21)
102-
10399
***
104100

105101
### getTargetEl()
106102

107103
> **getTargetEl**(): `undefined` \| [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement)
108104
105+
Defined in: [packages/core/src/utils/Mountable.ts:22](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/43804cae2c305431d6768245a6348f2ee7f14fca/packages/core/src/utils/Mountable.ts#L22)
106+
109107
Get the element that the mountable is currently mounted to.
110108

111109
#### Returns
@@ -116,30 +114,26 @@ Get the element that the mountable is currently mounted to.
116114

117115
[`Mountable`](/obsidian-meta-bind-plugin-docs/api/classes/mountable/).[`getTargetEl`](/obsidian-meta-bind-plugin-docs/api/classes/mountable/#gettargetel)
118116

119-
#### Defined in
120-
121-
[packages/core/src/utils/Mountable.ts:22](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/f797e384bc51b3b69ee936c1c8f585862087d6d3/packages/core/src/utils/Mountable.ts#L22)
122-
123117
***
124118

125119
### getUuid()
126120

127121
> **getUuid**(): `string`
128122
123+
Defined in: [packages/core/src/fields/FieldMountable.ts:17](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/43804cae2c305431d6768245a6348f2ee7f14fca/packages/core/src/fields/FieldMountable.ts#L17)
124+
129125
#### Returns
130126

131127
`string`
132128

133-
#### Defined in
134-
135-
[packages/core/src/fields/FieldMountable.ts:17](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/f797e384bc51b3b69ee936c1c8f585862087d6d3/packages/core/src/fields/FieldMountable.ts#L17)
136-
137129
***
138130

139131
### isMounted()
140132

141133
> **isMounted**(): `boolean`
142134
135+
Defined in: [packages/core/src/utils/Mountable.ts:15](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/43804cae2c305431d6768245a6348f2ee7f14fca/packages/core/src/utils/Mountable.ts#L15)
136+
143137
Check if the mountable is currently mounted.
144138

145139
#### Returns
@@ -150,16 +144,14 @@ Check if the mountable is currently mounted.
150144

151145
[`Mountable`](/obsidian-meta-bind-plugin-docs/api/classes/mountable/).[`isMounted`](/obsidian-meta-bind-plugin-docs/api/classes/mountable/#ismounted)
152146

153-
#### Defined in
154-
155-
[packages/core/src/utils/Mountable.ts:15](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/f797e384bc51b3b69ee936c1c8f585862087d6d3/packages/core/src/utils/Mountable.ts#L15)
156-
157147
***
158148

159149
### mount()
160150

161151
> **mount**(`targetEl`): `void`
162152
153+
Defined in: [packages/core/src/utils/Mountable.ts:50](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/43804cae2c305431d6768245a6348f2ee7f14fca/packages/core/src/utils/Mountable.ts#L50)
154+
163155
Mount the mountable to the given element.
164156
Will throw an error if the mountable is already mounted.
165157

@@ -200,16 +192,14 @@ Will throw an error if the mountable is already mounted.
200192

201193
[`Mountable`](/obsidian-meta-bind-plugin-docs/api/classes/mountable/).[`mount`](/obsidian-meta-bind-plugin-docs/api/classes/mountable/#mount)
202194

203-
#### Defined in
204-
205-
[packages/core/src/utils/Mountable.ts:50](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/f797e384bc51b3b69ee936c1c8f585862087d6d3/packages/core/src/utils/Mountable.ts#L50)
206-
207195
***
208196

209197
### registerUnmountCb()
210198

211199
> **registerUnmountCb**(`cb`): `void`
212200
201+
Defined in: [packages/core/src/utils/Mountable.ts:91](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/43804cae2c305431d6768245a6348f2ee7f14fca/packages/core/src/utils/Mountable.ts#L91)
202+
213203
Register a callback that will be called when the mountable is unmounted.
214204

215205
#### Parameters
@@ -249,18 +239,15 @@ Register a callback that will be called when the mountable is unmounted.
249239

250240
[`Mountable`](/obsidian-meta-bind-plugin-docs/api/classes/mountable/).[`registerUnmountCb`](/obsidian-meta-bind-plugin-docs/api/classes/mountable/#registerunmountcb)
251241

252-
#### Defined in
253-
254-
[packages/core/src/utils/Mountable.ts:85](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/f797e384bc51b3b69ee936c1c8f585862087d6d3/packages/core/src/utils/Mountable.ts#L85)
255-
256242
***
257243

258244
### unmount()
259245

260246
> **unmount**(): `void`
261247
248+
Defined in: [packages/core/src/utils/Mountable.ts:70](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/43804cae2c305431d6768245a6348f2ee7f14fca/packages/core/src/utils/Mountable.ts#L70)
249+
262250
Unmount the mountable from the current element.
263-
Will throw an error if the mountable is not mounted.
264251

265252
#### Returns
266253

@@ -269,7 +256,3 @@ Will throw an error if the mountable is not mounted.
269256
#### Inherited from
270257

271258
[`Mountable`](/obsidian-meta-bind-plugin-docs/api/classes/mountable/).[`unmount`](/obsidian-meta-bind-plugin-docs/api/classes/mountable/#unmount)
272-
273-
#### Defined in
274-
275-
[packages/core/src/utils/Mountable.ts:65](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/f797e384bc51b3b69ee936c1c8f585862087d6d3/packages/core/src/utils/Mountable.ts#L65)

0 commit comments

Comments
 (0)