Skip to content

Commit 9e9fdb2

Browse files
committed
feat: enhance ui, blog, docs and move index page in content first level
1 parent d6bdb87 commit 9e9fdb2

35 files changed

+657
-496
lines changed

.astro/content-modules.mjs

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

22
export default new Map([
33
["content/blog/welcome.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fblog%2Fwelcome.mdx&astroContentModuleFlag=true")],
4+
["content/docs/framework/deploy.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fframework%2Fdeploy.mdx&astroContentModuleFlag=true")],
5+
["content/docs/framework/getting-started.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fframework%2Fgetting-started.mdx&astroContentModuleFlag=true")],
46
["content/docs/framework/configuration.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fframework%2Fconfiguration.mdx&astroContentModuleFlag=true")],
57
["content/docs/framework/blog.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fframework%2Fblog.mdx&astroContentModuleFlag=true")],
6-
["content/docs/framework/deploy.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fframework%2Fdeploy.mdx&astroContentModuleFlag=true")],
78
["content/docs/framework/docs.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fframework%2Fdocs.mdx&astroContentModuleFlag=true")],
8-
["content/docs/framework/getting-started.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fframework%2Fgetting-started.mdx&astroContentModuleFlag=true")],
99
["content/docs/framework/installation.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fframework%2Finstallation.mdx&astroContentModuleFlag=true")],
1010
["content/docs/framework/project-structure.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fframework%2Fproject-structure.mdx&astroContentModuleFlag=true")],
11+
["content/about.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fabout.mdx&astroContentModuleFlag=true")],
12+
["content/index.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Findex.mdx&astroContentModuleFlag=true")],
13+
["content/docs/framework/_default.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fframework%2F_default.mdx&astroContentModuleFlag=true")],
14+
["content/docs/syntax/_default.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fsyntax%2F_default.mdx&astroContentModuleFlag=true")],
1115
["content/docs/syntax/code-block.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fsyntax%2Fcode-block.mdx&astroContentModuleFlag=true")],
12-
["content/docs/syntax/alert.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fsyntax%2Falert.mdx&astroContentModuleFlag=true")],
1316
["content/docs/syntax/markdown.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fsyntax%2Fmarkdown.mdx&astroContentModuleFlag=true")],
14-
["content/docs/syntax/text.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fsyntax%2Ftext.mdx&astroContentModuleFlag=true")],
15-
["content/docs/syntax/_default.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fsyntax%2F_default.mdx&astroContentModuleFlag=true")],
16-
["content/docs/framework/_default.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fframework%2F_default.mdx&astroContentModuleFlag=true")]]);
17+
["content/docs/syntax/alert.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fsyntax%2Falert.mdx&astroContentModuleFlag=true")],
18+
["content/docs/syntax/text.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fsyntax%2Ftext.mdx&astroContentModuleFlag=true")]]);
1719

.astro/content.d.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,14 @@ declare module 'astro:content' {
197197
rendered?: RenderedContent;
198198
filePath?: string;
199199
}>;
200+
"pages": Record<string, {
201+
id: string;
202+
body?: string;
203+
collection: "pages";
204+
data: InferEntrySchema<"pages">;
205+
rendered?: RenderedContent;
206+
filePath?: string;
207+
}>;
200208
"syntax": Record<string, {
201209
id: string;
202210
body?: string;

.astro/data-store.json

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

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@ node_modules/
22
dist/
33
.idea
44
.vscode
5+
.DS_Store

astro.config.mjs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ import rehypeCallouts from "rehype-callouts";
1717
import rehypeMermaid from "rehype-mermaid";
1818
import rehypeCodeGroupReact from "./src/lib/plugins/code-group/plugin";
1919
import rehypeReadMoreReact from "./src/lib/plugins/read-more/plugin";
20+
import rehypeBlogListReact from "./src/lib/plugins/blog-list/plugin";
2021
import {
2122
default as remarkDirective,
2223
default as remarkReadMoreDirective,
@@ -63,6 +64,7 @@ export default defineConfig({
6364
],
6465
rehypeCodeGroupReact,
6566
rehypeReadMoreReact,
67+
rehypeBlogListReact,
6668
],
6769
},
6870

content/about.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
---
3+
4+
# About
5+
6+
:::blog-list

content/blog/welcome.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ Explainer fills an important gap in the technical documentation ecosystem. While
1919

2020
This is where Astro, and by extension Explainer, particularly shines. Astro offers remarkable flexibility by allowing you to integrate any technological component related to your business. You can easily incorporate React, Vue, Svelte components, or even standard web elements according to your specific needs.
2121

22-
This agnostic approach allows you to create documentation that perfectly aligns with your existing technology stack, without forcing you to adopt a particular ecosystem. Whether you work with React, Vue, or other frameworks, Explainer adapts to your needs rather than the other way around.
22+
This agnostic approach allows you to create documentation that perfectly aligns with your existing technology stack, without forcing you to adopt a particular ecosystem. Whether you work with React, Vue, or other frameworks, Explainer adapts to your needs rather than the other way around.

content/docs/framework/_default.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@ description: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
55
permalink: framework
66
icon: lucide:cuboid
77
collection:
8-
- getting-started: true
9-
- deploy: true
10-
- project-structure: true
8+
- getting-started: false
9+
- installation: true
10+
- project-structure: false
11+
- configuration: true
12+
- docs: true
13+
- deploy: false
14+
- blog: true
1115
---

content/docs/framework/blog.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ You should use the frontmatter on top of the file to define the article metadata
2121
> [!WARNING]
2222
> The `permalink` property is required. If you modify it, the URL of the article will change.
2323
24-
:::code-group labels=[frontmatter, schema]
24+
:::codegroup labels=[frontmatter, schema]
2525

2626
```mdx
2727
---

content/docs/framework/getting-started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ permalink: getting-started
55
icon: lucide:info
66
order: 1
77
---
8+
89
# Getting Started 🚀
910

1011
## Introduction
1112

1213
Explainer provides a rich set of components that can be used directly in your Markdown files. This documentation outlines the various markdown components available for creating beautiful, interactive documentation.
13-

0 commit comments

Comments
 (0)