Skip to content

Commit 8e37041

Browse files
LeadcodeDevLeadcodeDev
committed
feat: enhance ui and documentation declaration
1 parent 438a11d commit 8e37041

File tree

23 files changed

+1154
-1036
lines changed

23 files changed

+1154
-1036
lines changed

‎.astro/collections/docDefaults.schema.json‎

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

‎.astro/content-modules.mjs‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11

22
export default new Map([
3-
["src/content/blog/welcome.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fblog%2Fwelcome.mdx&astroContentModuleFlag=true")],
43
["src/content/docs/framework/blog.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fframework%2Fblog.mdx&astroContentModuleFlag=true")],
4+
["src/content/docs/framework/docs.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fframework%2Fdocs.mdx&astroContentModuleFlag=true")],
55
["src/content/docs/framework/configuration.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fframework%2Fconfiguration.mdx&astroContentModuleFlag=true")],
66
["src/content/docs/framework/deploy.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fframework%2Fdeploy.mdx&astroContentModuleFlag=true")],
7-
["src/content/docs/framework/docs.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fframework%2Fdocs.mdx&astroContentModuleFlag=true")],
87
["src/content/docs/framework/getting-started.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fframework%2Fgetting-started.mdx&astroContentModuleFlag=true")],
98
["src/content/docs/framework/installation.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fframework%2Finstallation.mdx&astroContentModuleFlag=true")],
109
["src/content/docs/framework/project-structure.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fframework%2Fproject-structure.mdx&astroContentModuleFlag=true")],
11-
["src/content/docs/syntax/alert.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fsyntax%2Falert.mdx&astroContentModuleFlag=true")],
10+
["src/content/blog/welcome.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fblog%2Fwelcome.mdx&astroContentModuleFlag=true")],
1211
["src/content/docs/syntax/code-block.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fsyntax%2Fcode-block.mdx&astroContentModuleFlag=true")],
12+
["src/content/docs/syntax/text.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fsyntax%2Ftext.mdx&astroContentModuleFlag=true")],
1313
["src/content/docs/syntax/markdown.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fsyntax%2Fmarkdown.mdx&astroContentModuleFlag=true")],
14-
["src/content/docs/syntax/text.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fsyntax%2Ftext.mdx&astroContentModuleFlag=true")]]);
14+
["src/content/docs/syntax/alert.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fsyntax%2Falert.mdx&astroContentModuleFlag=true")],
15+
["src/content/docs/syntax/_default.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fsyntax%2F_default.mdx&astroContentModuleFlag=true")],
16+
["src/content/docs/framework/_default.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fframework%2F_default.mdx&astroContentModuleFlag=true")]]);
1517

‎.astro/content.d.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,14 @@ declare module 'astro:content' {
181181
rendered?: RenderedContent;
182182
filePath?: string;
183183
}>;
184+
"docDefaults": Record<string, {
185+
id: string;
186+
body?: string;
187+
collection: "docDefaults";
188+
data: InferEntrySchema<"docDefaults">;
189+
rendered?: RenderedContent;
190+
filePath?: string;
191+
}>;
184192
"framework": Record<string, {
185193
id: string;
186194
body?: string;

‎.astro/data-store.json‎

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

‎explainer.config.ts‎

Lines changed: 33 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,55 @@
1-
import { defineExplainerConfig } from '@/utils'
1+
import { defineExplainerConfig } from "@/utils";
22

33
export default defineExplainerConfig({
4+
seo: {
5+
title: "Explainer",
6+
titleTemplate: "{} - {title}",
7+
description:
8+
"Quickly design your documentation and optimise it for search engine optimisation to showcase your products.",
9+
thumbnail: "https://placehold.co/1200x630",
10+
},
11+
socials: {
12+
github: "https://github.com/LeadcodeDev/explainer",
13+
twitter: "https://twitter.com/LeadcodeDev",
14+
},
15+
docs: {},
16+
417
meta: {
5-
title: 'Explainer',
6-
description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
7-
thumbnail: 'https://placehold.co/1200x630',
18+
title: "Explainer",
19+
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
20+
thumbnail: "https://placehold.co/1200x630",
821
},
922
urls: {
10-
github: 'https://github.com/LeadcodeDev/explainer',
11-
getStarted: '/docs/framework/getting-started',
12-
documentation: '/docs/framework/installation'
13-
},
14-
docs: {
15-
framework: {
16-
icon: 'lucide:cuboid',
17-
label: 'Framework',
18-
href: '/docs/framework/getting-started',
19-
baseUrl: '/docs/framework',
20-
baseRepositoryUrl: 'https://github.com/LeadcodeDev/explainer',
21-
},
22-
syntax: {
23-
icon: 'lucide:pencil-line',
24-
label: 'Syntax',
25-
href: '/docs/syntax/texts',
26-
baseUrl: '/docs/syntax',
27-
baseRepositoryUrl: 'https://github.com/LeadcodeDev/explainer',
28-
},
23+
github: "https://github.com/LeadcodeDev/explainer",
24+
getStarted: "/docs/framework/getting-started",
25+
documentation: "/docs/framework/installation",
2926
},
3027
blog: {
3128
defaults: {
32-
thumbnail: 'https://placehold.co/1200x630',
29+
thumbnail: "https://placehold.co/1200x630",
3330
},
3431
authors: {
3532
leadcode_dev: {
36-
name: 'LeadcodeDev',
37-
avatar: 'https://avatars.githubusercontent.com/u/8946317?v=4',
38-
href: 'https://github.com/LeadcodeDev',
33+
name: "LeadcodeDev",
34+
avatar: "https://avatars.githubusercontent.com/u/8946317?v=4",
35+
href: "https://github.com/LeadcodeDev",
3936
},
40-
}
37+
},
4138
},
4239
navbar: [
4340
{
44-
label: 'Docs',
45-
items: [
46-
{
47-
label: 'Framework',
48-
description: 'Discover Explainer framework guidelines and usages.',
49-
href: '/docs/framework/getting-started',
50-
},
51-
{
52-
label: 'Syntax',
53-
description: 'Learn markdown syntax and markdown components.',
54-
href: '/docs/syntax/texts',
55-
},
56-
],
41+
label: "API",
42+
href: "/api",
5743
},
5844
{
59-
label: 'API',
60-
href: '/api',
61-
},
62-
{
63-
label: 'Blog',
64-
href: '/blog',
45+
label: "Blog",
46+
href: "/blog",
6547
},
6648
],
6749
social: {
6850
github: {
69-
href: 'https://github.com/LeadcodeDev/explainer',
70-
icon: 'mdi:github',
51+
href: "https://github.com/LeadcodeDev/explainer",
52+
icon: "mdi:github",
7153
},
72-
}
73-
})
54+
},
55+
});

‎package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
"@types/hast": "^3.0.4",
2525
"@types/luxon": "^3.6.2",
2626
"@types/mdast": "^4.0.4",
27+
"@types/node": "^24.10.0",
2728
"@types/react": "^19.0.12",
2829
"@types/react-dom": "^19.0.4",
2930
"astro": "^5.5.5",

‎pnpm-lock.yaml‎

Lines changed: 26 additions & 21 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)