Skip to content

Commit db2548c

Browse files
committed
add examples
1 parent a608858 commit db2548c

File tree

60 files changed

+1841
-4358
lines changed

Some content is hidden

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

60 files changed

+1841
-4358
lines changed

astro.config.mjs

Lines changed: 63 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,8 @@
11
import { defineConfig } from 'astro/config';
22
import starlight from '@astrojs/starlight';
3-
import { generateTypeDoc } from 'starlight-typedoc';
4-
5-
const typeDocSidebarGroup = await generateTypeDoc({
6-
entryPoints: ['obsidian-js-engine-plugin/jsEngine/api/*', 'obsidian-js-engine-plugin/jsEngine/engine/*'],
7-
typeDoc: {
8-
entryPointStrategy: 'expand',
9-
parametersFormat: 'table',
10-
propertiesFormat: 'list',
11-
enumMembersFormat: 'table',
12-
typeDeclarationFormat: 'table',
13-
excludePrivate: true,
14-
excludeProtected: true,
15-
useCodeBlocks: false,
16-
plugin: ['typedoc-plugin-mdn-links'],
17-
},
18-
tsconfig: 'obsidian-js-engine-plugin/tsconfig.json',
19-
sidebar: {
20-
label: 'API Reference',
21-
collapsed: true,
22-
},
23-
});
3+
import starlightTypeDoc, { typeDocSidebarGroup } from 'starlight-typedoc';
4+
import remarkMath from 'remark-math';
5+
import rehypeMathjax from 'rehype-mathjax';
246

257
// https://astro.build/config
268
export default defineConfig({
@@ -37,8 +19,68 @@ export default defineConfig({
3719
label: 'Guides',
3820
autogenerate: { directory: 'guides' },
3921
},
22+
{
23+
label: 'Examples',
24+
autogenerate: { directory: 'examples' },
25+
},
4026
typeDocSidebarGroup,
4127
],
28+
plugins: [
29+
starlightTypeDoc({
30+
entryPoints: [
31+
// 'obsidian-js-engine-plugin/JsEngine.d.ts',
32+
'obsidian-js-engine-plugin/jsEngine/api/API.ts',
33+
'obsidian-js-engine-plugin/jsEngine/api/Internal.ts',
34+
'obsidian-js-engine-plugin/jsEngine/api/LibAPI.ts',
35+
'obsidian-js-engine-plugin/jsEngine/api/MarkdownAPI.ts',
36+
'obsidian-js-engine-plugin/jsEngine/api/MessageAPI.ts',
37+
'obsidian-js-engine-plugin/jsEngine/api/reactive/ReactiveComponent.ts',
38+
'obsidian-js-engine-plugin/jsEngine/api/markdown/MarkdownString.ts',
39+
'obsidian-js-engine-plugin/jsEngine/api/markdown/MarkdownBuilder.ts',
40+
'obsidian-js-engine-plugin/jsEngine/api/markdown/MarkdownBuilder.ts',
41+
'obsidian-js-engine-plugin/jsEngine/engine/Engine.ts',
42+
'obsidian-js-engine-plugin/jsEngine/engine/JsExecution.ts',
43+
'obsidian-js-engine-plugin/jsEngine/engine/ResultRenderer.ts',
44+
],
45+
typeDoc: {
46+
entryPointStrategy: 'resolve',
47+
parametersFormat: 'table',
48+
propertiesFormat: 'list',
49+
enumMembersFormat: 'table',
50+
typeDeclarationFormat: 'table',
51+
excludePrivate: true,
52+
excludeProtected: true,
53+
excludeInternal: true,
54+
useCodeBlocks: true,
55+
groupOrder: [
56+
"Classes",
57+
"Functions",
58+
"Variables",
59+
"Type Aliases",
60+
"Interfaces",
61+
"Modules",
62+
"Namespaces",
63+
],
64+
categorizeByGroup: true,
65+
outputFileStrategy: 'members',
66+
67+
plugin: ['typedoc-plugin-mdn-links'],
68+
},
69+
tsconfig: 'obsidian-js-engine-plugin/tsconfig.json',
70+
sidebar: {
71+
label: 'API Reference',
72+
collapsed: false,
73+
},
74+
})
75+
]
4276
}),
4377
],
78+
markdown: {
79+
remarkPlugins: [
80+
remarkMath,
81+
],
82+
rehypePlugins: [
83+
rehypeMathjax
84+
]
85+
}
4486
});

0 commit comments

Comments
 (0)