Skip to content

Commit e8f25e8

Browse files
LeadcodeDevLeadcodeDev
committed
docs: write preface pages
1 parent 13b1efb commit e8f25e8

File tree

10 files changed

+353
-81
lines changed

10 files changed

+353
-81
lines changed

‎.astro/collections/gettingStarted.schema.json‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
{
2+
"$ref": "#/definitions/gettingStarted",
3+
"definitions": {
4+
"gettingStarted": {
5+
"type": "object",
6+
"properties": {
7+
"title": {
8+
"type": "string"
9+
},
10+
"description": {
11+
"type": "string"
12+
},
13+
"permalink": {
14+
"type": "string"
15+
},
16+
"order": {
17+
"type": "number"
18+
},
19+
"icon": {
20+
"type": "string"
21+
},
22+
"$schema": {
23+
"type": "string"
24+
}
25+
},
26+
"required": [
27+
"title",
28+
"description",
29+
"order"
30+
],
31+
"additionalProperties": false
32+
}
33+
},
34+
"$schema": "http://json-schema.org/draft-07/schema#"
35+
}

‎.astro/collections/preface.schema.json‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
{
2+
"$ref": "#/definitions/preface",
3+
"definitions": {
4+
"preface": {
5+
"type": "object",
6+
"properties": {
7+
"title": {
8+
"type": "string"
9+
},
10+
"description": {
11+
"type": "string"
12+
},
13+
"permalink": {
14+
"type": "string"
15+
},
16+
"order": {
17+
"type": "number"
18+
},
19+
"icon": {
20+
"type": "string"
21+
},
22+
"$schema": {
23+
"type": "string"
24+
}
25+
},
26+
"required": [
27+
"title",
28+
"description",
29+
"order"
30+
],
31+
"additionalProperties": false
32+
}
33+
},
34+
"$schema": "http://json-schema.org/draft-07/schema#"
35+
}

‎.astro/content-modules.mjs‎

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,28 @@
11

22
export default new Map([
3+
["src/content/docs/preface/contribute.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fpreface%2Fcontribute.mdx&astroContentModuleFlag=true")],
4+
["src/content/docs/preface/governance.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fpreface%2Fgovernance.mdx&astroContentModuleFlag=true")],
5+
["src/content/docs/preface/welcome.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fpreface%2Fwelcome.mdx&astroContentModuleFlag=true")],
36
["src/content/blog/welcome.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fblog%2Fwelcome.mdx&astroContentModuleFlag=true")],
4-
["src/content/docs/api/cli.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fcli.mdx&astroContentModuleFlag=true")],
57
["src/content/docs/api/commands.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fcommands.mdx&astroContentModuleFlag=true")],
6-
["src/content/docs/api/container.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fcontainer.mdx&astroContentModuleFlag=true")],
78
["src/content/docs/api/components.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fcomponents.mdx&astroContentModuleFlag=true")],
8-
["src/content/docs/api/environment-variables.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fenvironment-variables.mdx&astroContentModuleFlag=true")],
9+
["src/content/docs/api/cli.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fcli.mdx&astroContentModuleFlag=true")],
10+
["src/content/docs/api/container.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fcontainer.mdx&astroContentModuleFlag=true")],
911
["src/content/docs/api/global-states.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fglobal-states.mdx&astroContentModuleFlag=true")],
10-
["src/content/docs/api/hmr.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fhmr.mdx&astroContentModuleFlag=true")],
1112
["src/content/docs/api/interactive-components.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Finteractive-components.mdx&astroContentModuleFlag=true")],
1213
["src/content/docs/api/event.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fevent.mdx&astroContentModuleFlag=true")],
13-
["src/content/docs/api/placeholders.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fplaceholders.mdx&astroContentModuleFlag=true")],
14-
["src/content/docs/guide/deployment.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fguide%2Fdeployment.mdx&astroContentModuleFlag=true")],
1514
["src/content/docs/guide/commands.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fguide%2Fcommands.mdx&astroContentModuleFlag=true")],
15+
["src/content/docs/api/environment-variables.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fenvironment-variables.mdx&astroContentModuleFlag=true")],
16+
["src/content/docs/guide/event.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fguide%2Fevent.mdx&astroContentModuleFlag=true")],
1617
["src/content/docs/guide/environment-variables.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fguide%2Fenvironment-variables.mdx&astroContentModuleFlag=true")],
1718
["src/content/docs/guide/installation.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fguide%2Finstallation.mdx&astroContentModuleFlag=true")],
18-
["src/content/docs/guide/event.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fguide%2Fevent.mdx&astroContentModuleFlag=true")],
1919
["src/content/docs/guide/structure.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fguide%2Fstructure.mdx&astroContentModuleFlag=true")],
20-
["src/content/docs/concepts/datastore.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fconcepts%2Fdatastore.mdx&astroContentModuleFlag=true")],
2120
["src/content/docs/concepts/data-caching.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fconcepts%2Fdata-caching.mdx&astroContentModuleFlag=true")],
21+
["src/content/docs/concepts/datastore.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fconcepts%2Fdatastore.mdx&astroContentModuleFlag=true")],
22+
["src/content/docs/api/hmr.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fhmr.mdx&astroContentModuleFlag=true")],
23+
["src/content/docs/api/placeholders.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fplaceholders.mdx&astroContentModuleFlag=true")],
2224
["src/content/docs/concepts/immutability.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fconcepts%2Fimmutability.mdx&astroContentModuleFlag=true")],
2325
["src/content/docs/examples/ping-pong.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fexamples%2Fping-pong.mdx&astroContentModuleFlag=true")],
24-
["src/content/docs/api/providers.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fproviders.mdx&astroContentModuleFlag=true")],
25-
["src/content/docs/guide/deployment copy.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fguide%2Fdeployment+copy.mdx&astroContentModuleFlag=true")],
26-
["src/content/docs/guide/contribute.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fguide%2Fcontribute.mdx&astroContentModuleFlag=true")]]);
26+
["src/content/docs/guide/deployment.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fguide%2Fdeployment.mdx&astroContentModuleFlag=true")],
27+
["src/content/docs/api/providers.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fproviders.mdx&astroContentModuleFlag=true")]]);
2728

‎.astro/content.d.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,14 @@ declare module 'astro:content' {
213213
rendered?: RenderedContent;
214214
filePath?: string;
215215
}>;
216+
"preface": Record<string, {
217+
id: string;
218+
body?: string;
219+
collection: "preface";
220+
data: InferEntrySchema<"preface">;
221+
rendered?: RenderedContent;
222+
filePath?: string;
223+
}>;
216224

217225
};
218226

‎.astro/data-store.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎explainer.config.ts‎

Lines changed: 60 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,100 +1,107 @@
1-
import { defineExplainerConfig } from '@/utils'
1+
import { defineExplainerConfig } from "@/utils";
22

33
export default defineExplainerConfig({
44
meta: {
5-
title: 'Mineral framework',
6-
description: 'Mineral is a Discord framework for designing discord bots in Dart',
7-
thumbnail: 'https://placehold.co/1200x630',
5+
title: "Mineral framework",
6+
description:
7+
"Mineral is a Discord framework for designing discord bots in Dart",
8+
thumbnail: "https://placehold.co/1200x630",
89
},
910
urls: {
10-
github: 'https://github.com/mineral-dart/core',
11-
getStarted: '/docs/framework/getting-started',
12-
documentation: '/docs/framework/installation'
11+
github: "https://github.com/mineral-dart/core",
12+
getStarted: "/docs/framework/getting-started",
13+
documentation: "/docs/framework/installation",
1314
},
1415
docs: {
1516
_default: {
1617
source: {
17-
docs: 'https://github.com/mineral-dart/website/blob/main',
18-
issues: 'https://github.com/mineral-dart/core'
19-
}
18+
docs: "https://github.com/mineral-dart/website/blob/main",
19+
issues: "https://github.com/mineral-dart/core",
20+
},
21+
},
22+
preface: {
23+
icon: "lucide:house",
24+
label: "Preface",
25+
href: "/docs/preface/welcome",
26+
baseUrl: "/docs/preface",
2027
},
2128
guide: {
22-
icon: 'lucide:book-open',
23-
label: 'Guide',
24-
href: '/docs/guide/installation',
25-
baseUrl: '/docs/guide',
29+
icon: "lucide:book-open",
30+
label: "Guide",
31+
href: "/docs/guide/installation",
32+
baseUrl: "/docs/guide",
2633
},
2734
api: {
28-
icon: 'lucide:code-xml',
29-
label: 'API',
30-
href: '/docs/api/events',
31-
baseUrl: '/docs/api',
35+
icon: "lucide:code-xml",
36+
label: "API",
37+
href: "/docs/api/events",
38+
baseUrl: "/docs/api",
3239
},
3340
concepts: {
34-
icon: 'lucide:book-dashed',
35-
label: 'Concepts',
36-
href: '/docs/concepts/immutability',
37-
baseUrl: '/docs/concepts',
41+
icon: "lucide:book-dashed",
42+
label: "Concepts",
43+
href: "/docs/concepts/immutability",
44+
baseUrl: "/docs/concepts",
3845
},
3946
examples: {
40-
icon: 'lucide:app-window-mac',
41-
label: 'Examples',
42-
href: '/docs/examples/ping-pong',
43-
baseUrl: '/docs/examples',
47+
icon: "lucide:app-window-mac",
48+
label: "Examples",
49+
href: "/docs/examples/ping-pong",
50+
baseUrl: "/docs/examples",
4451
},
4552
},
4653
blog: {
4754
defaults: {
48-
thumbnail: 'https://placehold.co/1200x630',
55+
thumbnail: "https://placehold.co/1200x630",
4956
},
5057
authors: {
5158
leadcode_dev: {
52-
name: 'LeadcodeDev',
53-
avatar: 'https://avatars.githubusercontent.com/u/8946317?v=4',
54-
href: 'https://github.com/LeadcodeDev',
59+
name: "LeadcodeDev",
60+
avatar: "https://avatars.githubusercontent.com/u/8946317?v=4",
61+
href: "https://github.com/LeadcodeDev",
5562
},
56-
}
63+
},
5764
},
5865
navbar: [
5966
{
60-
label: 'Docs',
67+
label: "Docs",
6168
items: [
6269
{
63-
label: 'Guide',
64-
description: 'Build your first bot with the following guide.',
65-
href: '/docs/guide/installation',
70+
label: "Guide",
71+
description: "Build your first bot with the following guide.",
72+
href: "/docs/guide/installation",
6673
},
6774
{
68-
label: 'API',
69-
description: 'Learn the API of the framework.',
70-
href: '/docs/api/events',
75+
label: "API",
76+
description: "Learn the API of the framework.",
77+
href: "/docs/api/events",
7178
},
7279
{
73-
label: 'Concepts',
74-
description: 'Learn the concepts of the framework.',
75-
href: '/docs/concepts/immutability',
80+
label: "Concepts",
81+
description: "Learn the concepts of the framework.",
82+
href: "/docs/concepts/immutability",
7683
},
7784
{
78-
label: 'Examples',
79-
description: 'Learn the examples of the framework.',
80-
href: '/docs/examples/ping-pong',
85+
label: "Examples",
86+
description: "Learn the examples of the framework.",
87+
href: "/docs/examples/ping-pong",
8188
},
8289
],
8390
},
8491
{
85-
label: 'API',
86-
href: 'https://pub.dev/packages/mineral/versions/4.0.0-dev.11',
87-
target: '_blank',
92+
label: "API",
93+
href: "https://pub.dev/packages/mineral/versions/4.0.0-dev.11",
94+
target: "_blank",
8895
},
8996
{
90-
label: 'Blog',
91-
href: '/blog',
97+
label: "Blog",
98+
href: "/blog",
9299
},
93100
],
94101
social: {
95102
github: {
96-
href: 'https://github.com/LeadcodeDev/explainer',
97-
icon: 'mdi:github',
103+
href: "https://github.com/LeadcodeDev/explainer",
104+
icon: "mdi:github",
98105
},
99-
}
100-
})
106+
},
107+
});

‎src/content.config.ts‎

Lines changed: 35 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,41 @@ export const docSchema = z.object({
77
permalink: z.string().optional(),
88
order: z.number(),
99
icon: z.string().optional(),
10-
})
10+
});
11+
12+
const preface = defineCollection({
13+
loader: glob({
14+
pattern: "**/*.{md,mdx}",
15+
base: "./src/content/docs/preface",
16+
}),
17+
schema: docSchema,
18+
});
1119

1220
const guide = defineCollection({
1321
loader: glob({ pattern: "**/*.{md,mdx}", base: "./src/content/docs/guide" }),
14-
schema: docSchema
15-
})
22+
schema: docSchema,
23+
});
1624

1725
const api = defineCollection({
1826
loader: glob({ pattern: "**/*.{md,mdx}", base: "./src/content/docs/api" }),
19-
schema: docSchema
20-
})
27+
schema: docSchema,
28+
});
2129

2230
const concepts = defineCollection({
23-
loader: glob({ pattern: "**/*.{md,mdx}", base: "./src/content/docs/concepts" }),
24-
schema: docSchema
25-
})
31+
loader: glob({
32+
pattern: "**/*.{md,mdx}",
33+
base: "./src/content/docs/concepts",
34+
}),
35+
schema: docSchema,
36+
});
2637

2738
const examples = defineCollection({
28-
loader: glob({ pattern: "**/*.{md,mdx}", base: "./src/content/docs/examples" }),
29-
schema: docSchema
30-
})
39+
loader: glob({
40+
pattern: "**/*.{md,mdx}",
41+
base: "./src/content/docs/examples",
42+
}),
43+
schema: docSchema,
44+
});
3145

3246
const blog = defineCollection({
3347
loader: glob({ pattern: "**/*.{md,mdx}", base: "./src/content/blog" }),
@@ -37,8 +51,15 @@ const blog = defineCollection({
3751
permalink: z.string().optional(),
3852
thumbnail: z.string().optional(),
3953
authors: z.array(z.string()).optional(),
40-
publishedAt: z.string().optional()
54+
publishedAt: z.string().optional(),
4155
}),
42-
})
56+
});
4357

44-
export const collections = { blog, guide, api, concepts, examples };
58+
export const collections = {
59+
blog,
60+
preface,
61+
guide,
62+
api,
63+
concepts,
64+
examples,
65+
};

src/content/docs/guide/contribute.mdx renamed to src/content/docs/preface/contribute.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
title: Contribute
33
description: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
44
permalink: contribute
5-
icon: lucide:sparkles
6-
order: 1
5+
icon: lucide:wrench
6+
order: 3
77
---
88

99
# Contribute

0 commit comments

Comments
 (0)