Skip to content

Commit 6e49eb6

Browse files
committed
feat: enhance doc and add many navbar items
1 parent e1f78e1 commit 6e49eb6

File tree

14 files changed

+53
-46
lines changed

14 files changed

+53
-46
lines changed

.astro/collections/deepDocDefaults.schema.json

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@
1616
"icon": {
1717
"type": "string"
1818
},
19-
"directory": {
20-
"type": "string"
21-
},
2219
"collection": {
23-
"type": "array"
20+
"type": "array",
21+
"items": {
22+
"type": "string"
23+
}
2424
},
2525
"$schema": {
2626
"type": "string"
@@ -30,7 +30,6 @@
3030
"label",
3131
"description",
3232
"permalink",
33-
"directory",
3433
"collection"
3534
],
3635
"additionalProperties": false

.astro/collections/docDefaults.schema.json

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@
1616
"icon": {
1717
"type": "string"
1818
},
19-
"directory": {
20-
"type": "string"
21-
},
2219
"collection": {
23-
"type": "array"
20+
"type": "array",
21+
"items": {
22+
"type": "string"
23+
}
2424
},
2525
"$schema": {
2626
"type": "string"
@@ -30,7 +30,6 @@
3030
"label",
3131
"description",
3232
"permalink",
33-
"directory",
3433
"collection"
3534
],
3635
"additionalProperties": false

.astro/content-modules.mjs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11

22
export default new Map([
3-
["content/blog/index.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fblog%2Findex.mdx&astroContentModuleFlag=true")],
43
["content/blog/welcome.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fblog%2Fwelcome.mdx&astroContentModuleFlag=true")],
54
["content/index.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Findex.mdx&astroContentModuleFlag=true")],
65
["content/blog/lorem_ipsum.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fblog%2Florem_ipsum.mdx&astroContentModuleFlag=true")],
7-
["content/docs/documentation/_default.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2F_default.mdx&astroContentModuleFlag=true")],
8-
["content/docs/documentation/foundamentals/_default.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Ffoundamentals%2F_default.mdx&astroContentModuleFlag=true")],
9-
["content/docs/documentation/foundamentals/components/_default.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Ffoundamentals%2Fcomponents%2F_default.mdx&astroContentModuleFlag=true")],
10-
["content/docs/documentation/getting-started/_default.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Fgetting-started%2F_default.mdx&astroContentModuleFlag=true")],
6+
["content/blog/index.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fblog%2Findex.mdx&astroContentModuleFlag=true")],
117
["content/docs/documentation/foundamentals/blog.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Ffoundamentals%2Fblog.mdx&astroContentModuleFlag=true")],
128
["content/docs/documentation/foundamentals/docs.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Ffoundamentals%2Fdocs.mdx&astroContentModuleFlag=true")],
139
["content/docs/documentation/getting-started/configuration.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Fgetting-started%2Fconfiguration.mdx&astroContentModuleFlag=true")],
1410
["content/docs/documentation/foundamentals/routing.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Ffoundamentals%2Frouting.mdx&astroContentModuleFlag=true")],
15-
["content/docs/documentation/getting-started/deploy.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Fgetting-started%2Fdeploy.mdx&astroContentModuleFlag=true")],
16-
["content/docs/documentation/getting-started/installation.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Fgetting-started%2Finstallation.mdx&astroContentModuleFlag=true")],
1711
["content/docs/documentation/getting-started/project-structure.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Fgetting-started%2Fproject-structure.mdx&astroContentModuleFlag=true")],
18-
["content/docs/documentation/foundamentals/components/alert.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Ffoundamentals%2Fcomponents%2Falert.mdx&astroContentModuleFlag=true")],
1912
["content/docs/documentation/foundamentals/components/code-block.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Ffoundamentals%2Fcomponents%2Fcode-block.mdx&astroContentModuleFlag=true")],
13+
["content/docs/documentation/getting-started/installation.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Fgetting-started%2Finstallation.mdx&astroContentModuleFlag=true")],
2014
["content/docs/documentation/getting-started/getting-started.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Fgetting-started%2Fgetting-started.mdx&astroContentModuleFlag=true")],
21-
["content/docs/documentation/foundamentals/components/markdown.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Ffoundamentals%2Fcomponents%2Fmarkdown.mdx&astroContentModuleFlag=true")],
22-
["content/docs/documentation/foundamentals/components/text.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Ffoundamentals%2Fcomponents%2Ftext.mdx&astroContentModuleFlag=true")]]);
15+
["content/docs/documentation/getting-started/deploy.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Fgetting-started%2Fdeploy.mdx&astroContentModuleFlag=true")],
16+
["content/docs/documentation/foundamentals/components/alert.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Ffoundamentals%2Fcomponents%2Falert.mdx&astroContentModuleFlag=true")],
17+
["content/docs/documentation/_default.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2F_default.mdx&astroContentModuleFlag=true")],
18+
["content/docs/documentation/foundamentals/_default.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Ffoundamentals%2F_default.mdx&astroContentModuleFlag=true")],
19+
["content/docs/documentation/foundamentals/components/_default.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Ffoundamentals%2Fcomponents%2F_default.mdx&astroContentModuleFlag=true")],
20+
["content/docs/documentation/getting-started/_default.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Fgetting-started%2F_default.mdx&astroContentModuleFlag=true")],
21+
["content/docs/documentation/foundamentals/components/text.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Ffoundamentals%2Fcomponents%2Ftext.mdx&astroContentModuleFlag=true")],
22+
["content/docs/documentation/foundamentals/components/markdown.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=content%2Fdocs%2Fdocumentation%2Ffoundamentals%2Fcomponents%2Fmarkdown.mdx&astroContentModuleFlag=true")]]);
2323

.astro/data-store.json

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

content/docs/documentation/foundamentals/blog.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Blog
33
description: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
44
permalink: blog
55
icon: lucide:newspaper
6+
visibility:
7+
- navbar
68
---
79

810
import config from "explainer.config";

content/docs/documentation/foundamentals/components/alert.mdx

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ title: Alert
33
description: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
44
permalink: alert
55
icon: lucide:bell
6-
order: 3
76
---
7+
88
# Alert
99

10-
Alerts are UI components that help highlight important information to users. They can be used to provide feedback, warnings, errors, or general notes.
10+
Alerts are UI components that help highlight important information to users. They can be used to provide feedback, warnings, errors, or general notes.
1111

1212
In Explainer, alerts can be created using a simple Markdown syntax and can be either expanded by default or collapsible. Different types of alerts (`success`, `warning`, `note`, `error`) are available to convey different levels of importance or urgency.
1313

@@ -17,6 +17,7 @@ In Explainer, alerts can be created using a simple Markdown syntax and can be ei
1717
> [!success]
1818
> Some content is displayed directly!
1919
```
20+
2021
> [!success]
2122
> Some content is displayed directly!
2223
@@ -26,6 +27,7 @@ In Explainer, alerts can be created using a simple Markdown syntax and can be ei
2627
> [!warning] This is a **collapsible** callout
2728
> Some content shown after opening!
2829
```
30+
2931
> [!warning] This is a **collapsible** callout
3032
> Some content shown after opening!
3133
@@ -35,6 +37,7 @@ In Explainer, alerts can be created using a simple Markdown syntax and can be ei
3537
> [!note] This is a **collapsible** callout
3638
> Some content shown after opening!
3739
```
40+
3841
> [!note] This is a **collapsible** callout
3942
> Some content shown after opening!
4043
@@ -44,6 +47,7 @@ In Explainer, alerts can be created using a simple Markdown syntax and can be ei
4447
> [!error] This is a **collapsible** callout
4548
> Some content shown after opening!
4649
```
50+
4751
> [!error] This is a **collapsible** callout
4852
> Some content shown after opening!
4953
@@ -53,5 +57,6 @@ In Explainer, alerts can be created using a simple Markdown syntax and can be ei
5357
> [!important] This is a **collapsible** callout
5458
> Some content shown after opening!
5559
```
60+
5661
> [!important] This is a **collapsible** callout
57-
> Some content shown after opening!
62+
> Some content shown after opening!

content/docs/documentation/foundamentals/components/code-block.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ title: Code blocks
33
description: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
44
permalink: code-blocks
55
icon: lucide:code
6-
order: 4
76
---
87

98
# Code blocks

content/docs/documentation/foundamentals/components/markdown.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ title: Markdown
33
description: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
44
permalink: markdown
55
icon: lucide:highlighter
6-
order: 2
76
---
87

98
# Markdown utilities

content/docs/documentation/foundamentals/components/text.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Texts
33
description: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
44
permalink: texts
55
icon: lucide:letter-text
6-
order: 1
76
---
7+
88
# Texts
99

1010
## Introduction
@@ -16,7 +16,7 @@ Explainer provides a rich set of components that can be used directly in your Ma
1616
Markdown supports various text formatting options:
1717

1818
- **Bold text** using `**bold**`
19-
- *Italic text* using `*italic*`
19+
- _Italic text_ using `*italic*`
2020
- ~~Strikethrough~~ using `~~strikethrough~~`
2121
- `Inline code` using backticks
2222

@@ -26,7 +26,10 @@ You can create headers from level 1 (largest) to level 6 (smallest):
2626

2727
```mdx
2828
# Header 1
29+
2930
## Header 2
31+
3032
### Header 3
33+
3134
#### Header 4
32-
```
35+
```

content/docs/documentation/foundamentals/docs.mdx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Documentation
33
description: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
44
permalink: docs
55
icon: lucide:book
6+
visibility:
7+
- navbar
68
---
79

810
# Documentation
@@ -47,8 +49,8 @@ description: My doc description
4749
permalink: my-doc
4850
icon: lucide:cuboid
4951
collection:
50-
- first_file: true
51-
- second_file: false
52+
- first_file
53+
- second_file
5254
---
5355
```
5456

@@ -59,22 +61,20 @@ export const docDefaultSchema = z.object({
5961
permalink: z.string(),
6062
icon: z.string().optional(),
6163
directory: z.string(),
62-
collection: z.array(z.any()),
64+
collection: z.array(z.string()),
6365
});
6466
```
6567

6668
:::
6769

68-
| Property | Description |
69-
| --------------------- | ------------------------------------------------------- |
70-
| `label` | Display collection name |
71-
| `description` | Description of your collection |
72-
| `permalink` | Collection url |
73-
| `icon` | Icon Using `iconify` library |
74-
| `directory` | Directory name inside `docs/` |
75-
| `collection` | Collection items, used to define order |
76-
| `collection[n].key` | Documentation filename inside directory |
77-
| `collection[n].value` | Hide or show this documentation page inside navbar menu |
70+
| Property | Description |
71+
| ------------- | ------------------------------------------------ |
72+
| `label` | Display collection name |
73+
| `description` | Description of your collection |
74+
| `permalink` | Collection url |
75+
| `icon` | Icon Using `iconify` library |
76+
| `directory` | Directory name inside `docs/` |
77+
| `collection` | Collection folder or items, used to define order |
7878

7979
---
8080

0 commit comments

Comments
 (0)