@sp-days-framework/create-sp-days 1.0.3 → 1.1.0-beta1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -0
- package/bin/index.js +2 -0
- package/docs/advanced-config.mdx +387 -0
- package/docs/changelog.mdx +106 -0
- package/docs/index.mdx +205 -0
- package/docs/install.mdx +199 -0
- package/docs/sidebar-sections.mdx +268 -0
- package/docs/sp-days-plugin-color-light.svg +53 -0
- package/lib/.tsbuildinfo +1 -0
- package/lib/.tsbuildinfo-build +1 -0
- package/lib/index.d.ts +1 -0
- package/lib/index.js +36 -7
- package/package.json +31 -7
- package/publish-package-docs.js +12 -0
- package/templates/addon-resources/resources/api-reference.mdx +132 -0
- package/templates/addon-resources/resources/best-practice.mdx +407 -0
- package/templates/addon-resources/resources/cheat-sheet.mdx +120 -0
- package/templates/addon-resources/resources/cli-reference.mdx +280 -0
- package/templates/addon-resources/resources/configuration-guide.mdx +211 -0
- package/templates/addon-resources/resources/environment-setup.mdx +317 -0
- package/templates/addon-resources/resources/faq.mdx +146 -0
- package/templates/addon-resources/resources/glossary.mdx +78 -0
- package/templates/addon-resources/resources/index.mdx +67 -16
- package/templates/addon-resources/resources/quick-start.mdx +193 -0
- package/templates/addon-resources/resources/troubleshooting.mdx +263 -0
- package/templates/addon-resources/resources/useful-links.mdx +61 -0
- package/templates/page-course/README.md +62 -0
- package/templates/page-course/docusaurus.config.ts +65 -5
- package/templates/page-course/package.json +12 -2
- package/templates/page-course/sidebarSections.js +118 -0
- package/tsconfig.base.client.json +10 -0
- package/tsconfig.base.json +71 -0
- package/tsconfig.build.json +9 -0
- package/templates/addon-resources/resources/frontpage-collection/components/Columns.mdx +0 -191
- package/templates/addon-resources/resources/frontpage-collection/components/ContentBlock.mdx +0 -126
- package/templates/addon-resources/resources/frontpage-collection/components/CourseFeature.mdx +0 -147
- package/templates/addon-resources/resources/frontpage-collection/components/FancyHeader.mdx +0 -76
- package/templates/addon-resources/resources/frontpage-collection/components/GetStarted.mdx +0 -222
- package/templates/addon-resources/resources/frontpage-collection/components/HeroBanner.mdx +0 -205
- package/templates/addon-resources/resources/frontpage-collection/components/IconContainer.mdx +0 -249
- package/templates/addon-resources/resources/frontpage-collection/components/Iconify.mdx +0 -228
- package/templates/addon-resources/resources/frontpage-collection/components/_category_.yml +0 -2
- package/templates/addon-resources/resources/frontpage-collection/index.mdx +0 -85
- package/templates/addon-resources/resources/frontpage-collection/setup/index.mdx +0 -185
- package/templates/addon-resources/resources/interactive-tasks/creating-tasks.mdx +0 -292
- package/templates/addon-resources/resources/interactive-tasks/examples/_category_.yml +0 -3
- package/templates/addon-resources/resources/interactive-tasks/examples/advanced-usage.mdx +0 -304
- package/templates/addon-resources/resources/interactive-tasks/examples/basic-usage.mdx +0 -128
- package/templates/addon-resources/resources/interactive-tasks/index.mdx +0 -93
- package/templates/addon-resources/resources/interactive-tasks/setup/advanced-configuration.mdx +0 -150
- package/templates/addon-resources/resources/interactive-tasks/setup/index.mdx +0 -174
- package/templates/addon-resources/resources/interactive-tasks/task-progression.mdx +0 -140
- package/templates/addon-resources/resources/slidev-integration/index.mdx +0 -106
- package/templates/addon-resources/resources/slidev-integration/setup/advanced-configuration.mdx +0 -144
- package/templates/addon-resources/resources/slidev-integration/setup/index.mdx +0 -200
- package/templates/addon-resources/resources/sykehuspartner-theme/index.mdx +0 -105
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/_category_.yml +0 -2
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/content/_category_.yml +0 -2
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/content/center.mdx +0 -33
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/content/default.mdx +0 -59
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/content/full.mdx +0 -49
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/image/_category_.yml +0 -2
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/image/image-left.mdx +0 -37
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/image/image-right.mdx +0 -37
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/image/image.mdx +0 -56
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/multi-column/_category_.yml +0 -2
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/multi-column/three-cols-header.mdx +0 -49
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/multi-column/three-cols.mdx +0 -47
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/multi-column/two-cols-header.mdx +0 -43
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/multi-column/two-cols.mdx +0 -38
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/section/_category_.yml +0 -2
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/section/cover.mdx +0 -43
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/section/end.mdx +0 -33
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/section/intro.mdx +0 -49
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/section/section.mdx +0 -41
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/special/_category_.yml +0 -2
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/special/about-me.mdx +0 -92
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/special/fact.mdx +0 -47
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/special/quote.mdx +0 -27
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/special/statement.mdx +0 -28
- package/templates/addon-resources/resources/sykehuspartner-theme/setup/advanced-configuration.mdx +0 -79
- package/templates/addon-resources/resources/sykehuspartner-theme/setup/index.mdx +0 -104
- package/templates/addon-resources/resources/sykehuspartner-theme/syntax-and-icons.mdx +0 -89
- package/templates/addon-slidev/package.json +0 -54
|
@@ -1,76 +0,0 @@
|
|
|
1
|
-
import Tabs from "@theme/Tabs";
|
|
2
|
-
import TabItem from "@theme/TabItem";
|
|
3
|
-
import { FancyHeader } from "@sp-days-framework/docusaurus-frontpage-collection";
|
|
4
|
-
|
|
5
|
-
# Fancy Header
|
|
6
|
-
|
|
7
|
-
A header component with a decorative underline accent.
|
|
8
|
-
|
|
9
|
-
<div className="preview">
|
|
10
|
-
<div className="container">
|
|
11
|
-
<FancyHeader as="h3">This is a Live Example</FancyHeader>
|
|
12
|
-
</div>
|
|
13
|
-
</div>
|
|
14
|
-
|
|
15
|
-
## Features
|
|
16
|
-
|
|
17
|
-
- Decorative underline accent
|
|
18
|
-
- Customizable heading level
|
|
19
|
-
- Primary color accent
|
|
20
|
-
- Automatic spacing
|
|
21
|
-
- Scroll margin for anchor links
|
|
22
|
-
|
|
23
|
-
## Import
|
|
24
|
-
|
|
25
|
-
<Tabs>
|
|
26
|
-
<TabItem value="individual" label="Individual import" default>
|
|
27
|
-
```mdx
|
|
28
|
-
import { FancyHeader } from "@sp-days-framework/docusaurus-frontpage-collection";
|
|
29
|
-
```
|
|
30
|
-
</TabItem>
|
|
31
|
-
<TabItem value="default" label="Default import">
|
|
32
|
-
```mdx
|
|
33
|
-
import FancyHeader from "@sp-days-framework/docusaurus-frontpage-collection/lib/components/FancyHeader";
|
|
34
|
-
```
|
|
35
|
-
</TabItem>
|
|
36
|
-
</Tabs>
|
|
37
|
-
|
|
38
|
-
## Basic Usage
|
|
39
|
-
|
|
40
|
-
```mdx
|
|
41
|
-
<FancyHeader>Section Title</FancyHeader>
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
## Props
|
|
45
|
-
|
|
46
|
-
| Prop | Type | Default | Description |
|
|
47
|
-
| ----------- | ---------------------------------------------- | -------- | ---------------------- |
|
|
48
|
-
| `as` | `'h1' \| 'h2' \| 'h3' \| 'h4' \| 'h5' \| 'h6'` | `'h2'` | Heading level |
|
|
49
|
-
| `className` | `string` | - | Additional CSS classes |
|
|
50
|
-
| `children` | `ReactNode` | required | Header text |
|
|
51
|
-
|
|
52
|
-
## Examples
|
|
53
|
-
|
|
54
|
-
### Default (h2)
|
|
55
|
-
|
|
56
|
-
```mdx
|
|
57
|
-
<FancyHeader>What You'll Learn</FancyHeader>
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
### Different Heading Levels
|
|
61
|
-
|
|
62
|
-
```mdx
|
|
63
|
-
<FancyHeader as="h1">Main Title</FancyHeader>
|
|
64
|
-
|
|
65
|
-
<FancyHeader as="h2">Section Title</FancyHeader>
|
|
66
|
-
|
|
67
|
-
<FancyHeader as="h3">Subsection Title</FancyHeader>
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
### With Custom Class
|
|
71
|
-
|
|
72
|
-
```mdx
|
|
73
|
-
<FancyHeader as="h2" className="my-custom-class">
|
|
74
|
-
Custom Styled Header
|
|
75
|
-
</FancyHeader>
|
|
76
|
-
```
|
|
@@ -1,222 +0,0 @@
|
|
|
1
|
-
import Tabs from "@theme/Tabs";
|
|
2
|
-
import TabItem from "@theme/TabItem";
|
|
3
|
-
import {
|
|
4
|
-
GetStarted,
|
|
5
|
-
Explore,
|
|
6
|
-
ExploreItem,
|
|
7
|
-
} from "@sp-days-framework/docusaurus-frontpage-collection";
|
|
8
|
-
|
|
9
|
-
# Get Started
|
|
10
|
-
|
|
11
|
-
A call-to-action component with an optional explore grid for additional resources.
|
|
12
|
-
|
|
13
|
-
<div className="preview">
|
|
14
|
-
<div className="container" style={{ paddingBottom: '1.5rem' }}>
|
|
15
|
-
<GetStarted buttonText="Get Started" buttonLink="/resources">
|
|
16
|
-
## Ready to Begin?
|
|
17
|
-
|
|
18
|
-
Start your learning journey today with our comprehensive course materials.
|
|
19
|
-
|
|
20
|
-
<Explore>
|
|
21
|
-
<ExploreItem
|
|
22
|
-
title="Interactive Tasks"
|
|
23
|
-
iconify="ci:window-check"
|
|
24
|
-
link="/resources"
|
|
25
|
-
>
|
|
26
|
-
Access all course modules and lessons
|
|
27
|
-
</ExploreItem>
|
|
28
|
-
<ExploreItem
|
|
29
|
-
title="Resources"
|
|
30
|
-
iconify="mdi:book-open-variant"
|
|
31
|
-
link="/resources"
|
|
32
|
-
>
|
|
33
|
-
Additional learning materials and references
|
|
34
|
-
</ExploreItem>
|
|
35
|
-
<ExploreItem
|
|
36
|
-
title="Presentations"
|
|
37
|
-
iconify="mdi:television-play"
|
|
38
|
-
link="/resources"
|
|
39
|
-
>
|
|
40
|
-
View presentation slides and notes
|
|
41
|
-
</ExploreItem>
|
|
42
|
-
</Explore>
|
|
43
|
-
</GetStarted>
|
|
44
|
-
</div>
|
|
45
|
-
</div>
|
|
46
|
-
|
|
47
|
-
## Features
|
|
48
|
-
|
|
49
|
-
- Central call-to-action button with pop animation
|
|
50
|
-
- Optional explore grid
|
|
51
|
-
- Responsive layout
|
|
52
|
-
- Icon support for explore items
|
|
53
|
-
- Hover effects with customizable colors
|
|
54
|
-
- Optional animation disable
|
|
55
|
-
|
|
56
|
-
## Import
|
|
57
|
-
|
|
58
|
-
<Tabs>
|
|
59
|
-
<TabItem value="individual" label="Individual import" default>
|
|
60
|
-
```mdx
|
|
61
|
-
import {
|
|
62
|
-
GetStarted,
|
|
63
|
-
Explore,
|
|
64
|
-
ExploreItem,
|
|
65
|
-
} from "@sp-days-framework/docusaurus-frontpage-collection";
|
|
66
|
-
```
|
|
67
|
-
</TabItem>
|
|
68
|
-
<TabItem value="default" label="Default import">
|
|
69
|
-
```mdx
|
|
70
|
-
import GetStarted, { Explore, ExploreItem } from "@sp-days-framework/docusaurus-frontpage-collection/lib/components/GetStarted";
|
|
71
|
-
```
|
|
72
|
-
</TabItem>
|
|
73
|
-
</Tabs>
|
|
74
|
-
|
|
75
|
-
## Basic Usage
|
|
76
|
-
|
|
77
|
-
```mdx
|
|
78
|
-
<GetStarted buttonText="Start Learning" buttonLink="/docs/intro">
|
|
79
|
-
## Ready to Begin?
|
|
80
|
-
|
|
81
|
-
Start with Module 1 and begin your journey!
|
|
82
|
-
|
|
83
|
-
<Explore>
|
|
84
|
-
<ExploreItem
|
|
85
|
-
title="Documentation"
|
|
86
|
-
iconify="mdi:book-open-variant"
|
|
87
|
-
link="/docs"
|
|
88
|
-
>
|
|
89
|
-
Comprehensive guides
|
|
90
|
-
</ExploreItem>
|
|
91
|
-
<ExploreItem
|
|
92
|
-
title="Examples"
|
|
93
|
-
iconify="mdi:code-tags"
|
|
94
|
-
link="/examples"
|
|
95
|
-
>
|
|
96
|
-
Sample projects
|
|
97
|
-
</ExploreItem>
|
|
98
|
-
</Explore>
|
|
99
|
-
</GetStarted>
|
|
100
|
-
```
|
|
101
|
-
|
|
102
|
-
## Props
|
|
103
|
-
|
|
104
|
-
### GetStarted
|
|
105
|
-
|
|
106
|
-
| Prop | Type | Description |
|
|
107
|
-
| ------------ | ----------- | ---------------------------------------------------- |
|
|
108
|
-
| `buttonText` | `string` | Text for the CTA button |
|
|
109
|
-
| `buttonLink` | `string` | Link for the CTA button |
|
|
110
|
-
| `children` | `ReactNode` | Content displayed above button and Explore component |
|
|
111
|
-
|
|
112
|
-
### Explore
|
|
113
|
-
|
|
114
|
-
| Prop | Type | Default | Description |
|
|
115
|
-
| ---------- | ----------- | --------- | -------------------------- |
|
|
116
|
-
| `children` | `ReactNode` | required | ExploreItem components |
|
|
117
|
-
| `minWidth` | `string` | `'250px'` | Minimum width for items |
|
|
118
|
-
| `columns` | `number` | `0` | Fixed columns (0 for auto) |
|
|
119
|
-
|
|
120
|
-
### ExploreItem
|
|
121
|
-
|
|
122
|
-
| Prop | Type | Description |
|
|
123
|
-
| ----------------- | ---------------------- | ------------------------------------- |
|
|
124
|
-
| `title` | `string` | Item title |
|
|
125
|
-
| `iconify` | `IconifyConfig\|string`| Iconify icon name or configuration |
|
|
126
|
-
| `customSvg` | `CustomSvgConfig` | Custom SVG files for light/dark themes (supports color override) |
|
|
127
|
-
| `customImage` | `CustomImageConfig` | Custom image files (PNG/JPEG) for light/dark themes |
|
|
128
|
-
| `iconColors` | `IconColorConfig` | Icon color overrides (light/dark/hover)|
|
|
129
|
-
| `titleColors` | `TitleColorConfig` | Title color overrides (light/dark/hover)|
|
|
130
|
-
| `disableAnimation`| `boolean` | Disable hover animation (default: false)|
|
|
131
|
-
| `link` | `string` | Link URL |
|
|
132
|
-
| `children` | `ReactNode` | Description content |
|
|
133
|
-
|
|
134
|
-
## Examples
|
|
135
|
-
|
|
136
|
-
### Simple CTA
|
|
137
|
-
|
|
138
|
-
```mdx
|
|
139
|
-
<GetStarted buttonText="Get Started" buttonLink="/docs">
|
|
140
|
-
Ready to learn? Click below to start!
|
|
141
|
-
</GetStarted>
|
|
142
|
-
```
|
|
143
|
-
|
|
144
|
-
### With Explore Grid
|
|
145
|
-
|
|
146
|
-
```mdx
|
|
147
|
-
<GetStarted buttonText="Start Learning" buttonLink="/docs/module1">
|
|
148
|
-
## Ready for Launch?
|
|
149
|
-
|
|
150
|
-
Begin your Docker journey today!
|
|
151
|
-
|
|
152
|
-
<Explore>
|
|
153
|
-
<ExploreItem title="Documentation" iconify="mdi:book" link="/docs">
|
|
154
|
-
Complete reference guides
|
|
155
|
-
</ExploreItem>
|
|
156
|
-
<ExploreItem title="Video Tutorials" iconify="mdi:video" link="/videos">
|
|
157
|
-
Step-by-step videos
|
|
158
|
-
</ExploreItem>
|
|
159
|
-
<ExploreItem title="Community" iconify="mdi:forum" link="/community">
|
|
160
|
-
Join the discussion
|
|
161
|
-
</ExploreItem>
|
|
162
|
-
</Explore>
|
|
163
|
-
</GetStarted>
|
|
164
|
-
```
|
|
165
|
-
|
|
166
|
-
### With Custom Colors
|
|
167
|
-
|
|
168
|
-
```mdx
|
|
169
|
-
<Explore>
|
|
170
|
-
<ExploreItem
|
|
171
|
-
title="Documentation"
|
|
172
|
-
iconify="mdi:book"
|
|
173
|
-
iconColors={{
|
|
174
|
-
light: "#1976d2",
|
|
175
|
-
lightHover: "#115293",
|
|
176
|
-
dark: "#90caf9",
|
|
177
|
-
darkHover: "#b3d9ff"
|
|
178
|
-
}}
|
|
179
|
-
titleColors={{
|
|
180
|
-
light: "#333333",
|
|
181
|
-
lightHover: "#1976d2"
|
|
182
|
-
}}
|
|
183
|
-
link="/docs"
|
|
184
|
-
>
|
|
185
|
-
Complete reference
|
|
186
|
-
</ExploreItem>
|
|
187
|
-
</Explore>
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
### Disable Animations
|
|
191
|
-
|
|
192
|
-
```mdx
|
|
193
|
-
<Explore>
|
|
194
|
-
<ExploreItem
|
|
195
|
-
title="Static Item"
|
|
196
|
-
iconify="mdi:information"
|
|
197
|
-
disableAnimation={true}
|
|
198
|
-
link="/info"
|
|
199
|
-
>
|
|
200
|
-
No hover effects
|
|
201
|
-
</ExploreItem>
|
|
202
|
-
</Explore>
|
|
203
|
-
```
|
|
204
|
-
|
|
205
|
-
### Fixed Column Layout
|
|
206
|
-
|
|
207
|
-
```mdx
|
|
208
|
-
<Explore columns={2}>
|
|
209
|
-
<ExploreItem title="Item 1" iconify="mdi:numeric-1" link="/1">
|
|
210
|
-
Content
|
|
211
|
-
</ExploreItem>
|
|
212
|
-
<ExploreItem title="Item 2" iconify="mdi:numeric-2" link="/2">
|
|
213
|
-
Content
|
|
214
|
-
</ExploreItem>
|
|
215
|
-
<ExploreItem title="Item 3" iconify="mdi:numeric-3" link="/3">
|
|
216
|
-
Content
|
|
217
|
-
</ExploreItem>
|
|
218
|
-
<ExploreItem title="Item 4" iconify="mdi:numeric-4" link="/4">
|
|
219
|
-
Content
|
|
220
|
-
</ExploreItem>
|
|
221
|
-
</Explore>
|
|
222
|
-
```
|
|
@@ -1,205 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
# hide_table_of_contents: true
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
import Tabs from "@theme/Tabs";
|
|
6
|
-
import TabItem from "@theme/TabItem";
|
|
7
|
-
import { HeroBanner } from "@sp-days-framework/docusaurus-frontpage-collection";
|
|
8
|
-
import remarkGfm from 'remark-gfm'
|
|
9
|
-
|
|
10
|
-
# Hero Banner
|
|
11
|
-
|
|
12
|
-
A full-width banner that displays at the top of your page. Perfect for course introductions and landing pages.
|
|
13
|
-
|
|
14
|
-
<div className="preview">
|
|
15
|
-
<div className="container" style={{ width: '-webkit-fill-available', paddingBottom: '1.5rem'}}>
|
|
16
|
-
<HeroBanner
|
|
17
|
-
bannerText="This is a live example"
|
|
18
|
-
bannerFullWidth={false}
|
|
19
|
-
iconify="mdi:docker"
|
|
20
|
-
/>
|
|
21
|
-
</div>
|
|
22
|
-
</div>
|
|
23
|
-
|
|
24
|
-
## Features
|
|
25
|
-
|
|
26
|
-
- Full-width design that breaks out of container constraints
|
|
27
|
-
- Automatic title and tagline from Docusaurus config
|
|
28
|
-
- Support for Iconify icons or custom images
|
|
29
|
-
- Customizable icon colors for light/dark themes
|
|
30
|
-
- Interactive dot cross grid background effect
|
|
31
|
-
|
|
32
|
-
## Import
|
|
33
|
-
|
|
34
|
-
<Tabs>
|
|
35
|
-
<TabItem value="individual" label="Individual import" default>
|
|
36
|
-
```mdx
|
|
37
|
-
import { HeroBanner } from "@sp-days-framework/docusaurus-frontpage-collection";
|
|
38
|
-
```
|
|
39
|
-
</TabItem>
|
|
40
|
-
<TabItem value="default" label="Default import">
|
|
41
|
-
```mdx
|
|
42
|
-
import HeroBanner from "@sp-days-framework/docusaurus-frontpage-collection/lib/components/HeroBanner";
|
|
43
|
-
```
|
|
44
|
-
</TabItem>
|
|
45
|
-
</Tabs>
|
|
46
|
-
|
|
47
|
-
## Basic Usage
|
|
48
|
-
|
|
49
|
-
```mdx
|
|
50
|
-
<HeroBanner
|
|
51
|
-
bannerText="Learn Docker with our hands-on operations course"
|
|
52
|
-
iconify="mdi:docker"
|
|
53
|
-
/>
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
## Props
|
|
57
|
-
|
|
58
|
-
| Prop | Type | Default | Description |
|
|
59
|
-
| ---------------------- | ---------------------- | ----------- | -------------------------------------------- |
|
|
60
|
-
| `bannerText` | `string` | `''` | Description text displayed in the banner |
|
|
61
|
-
| `bannerFullWidth` | `boolean` | `true` | Full viewport width or contained within doc content |
|
|
62
|
-
| `iconify` | `IconifyConfig\|string`| `undefined` | Iconify icon name or configuration object |
|
|
63
|
-
| `customSvg` | `CustomSvgConfig` | `undefined` | Custom SVG files for light/dark themes (supports color override) |
|
|
64
|
-
| `customImage` | `CustomImageConfig` | `undefined` | Custom image files (PNG/JPEG) for light/dark themes |
|
|
65
|
-
| `iconColors` | `IconColorConfig` | `undefined` | Optional color overrides for Iconify icons |
|
|
66
|
-
| `enableDotCrossEffect` | `boolean` | `true` | Enable interactive dot cross grid background |
|
|
67
|
-
| `dotCrossColor` | `string` | `#ffffff` | Color of the dot cross grid |
|
|
68
|
-
|
|
69
|
-
> **Note**: The banner automatically uses the site `title` and `tagline` from your `docusaurus.config.js`.
|
|
70
|
-
|
|
71
|
-
## Examples
|
|
72
|
-
|
|
73
|
-
### With Iconify Icon
|
|
74
|
-
|
|
75
|
-
```mdx
|
|
76
|
-
<HeroBanner
|
|
77
|
-
bannerText="Master Kubernetes deployment and orchestration"
|
|
78
|
-
iconify="mdi:kubernetes"
|
|
79
|
-
/>
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
### With Custom Icon Colors
|
|
83
|
-
|
|
84
|
-
```mdx
|
|
85
|
-
<HeroBanner
|
|
86
|
-
bannerText="Advanced Kubernetes Training"
|
|
87
|
-
iconify="mdi:kubernetes"
|
|
88
|
-
iconColors={{
|
|
89
|
-
light: "#326CE5",
|
|
90
|
-
dark: "#7CB9FF"
|
|
91
|
-
}}
|
|
92
|
-
/>
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
### With Custom SVG Images
|
|
96
|
-
|
|
97
|
-
```mdx
|
|
98
|
-
<HeroBanner
|
|
99
|
-
bannerText="Welcome to our comprehensive Docker course"
|
|
100
|
-
customSvg={{
|
|
101
|
-
light: "img/docker-logo-light.svg",
|
|
102
|
-
dark: "img/docker-logo-dark.svg",
|
|
103
|
-
}}
|
|
104
|
-
/>
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
### With Custom PNG/JPEG Images
|
|
109
|
-
|
|
110
|
-
```mdx
|
|
111
|
-
<HeroBanner
|
|
112
|
-
bannerText="Welcome to our comprehensive Docker course"
|
|
113
|
-
customImage={{
|
|
114
|
-
light: "img/docker-logo-light.png",
|
|
115
|
-
dark: "img/docker-logo-dark.png",
|
|
116
|
-
}}
|
|
117
|
-
/>
|
|
118
|
-
```
|
|
119
|
-
|
|
120
|
-
### With Advanced Iconify Configuration
|
|
121
|
-
|
|
122
|
-
```mdx
|
|
123
|
-
<HeroBanner
|
|
124
|
-
bannerText="Build modern cloud-native applications"
|
|
125
|
-
iconify={{
|
|
126
|
-
icon: "mdi:cloud",
|
|
127
|
-
width: "100%",
|
|
128
|
-
height: "100%",
|
|
129
|
-
colors: {
|
|
130
|
-
light: "#4285F4",
|
|
131
|
-
dark: "#8AB4F8"
|
|
132
|
-
}
|
|
133
|
-
}}
|
|
134
|
-
/>
|
|
135
|
-
```
|
|
136
|
-
|
|
137
|
-
### Minimal (No Icon)
|
|
138
|
-
|
|
139
|
-
```mdx
|
|
140
|
-
<HeroBanner bannerText="Simple text-only banner" />
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
### Disable Dot Cross Grid Effect
|
|
144
|
-
|
|
145
|
-
You can deactivate the effect by setting `enableDotCrossEffect` to `false`.
|
|
146
|
-
|
|
147
|
-
```mdx
|
|
148
|
-
<HeroBanner
|
|
149
|
-
bannerText="Interactive learning experience"
|
|
150
|
-
enableDotCrossEffect={false}
|
|
151
|
-
/>
|
|
152
|
-
```
|
|
153
|
-
|
|
154
|
-
### Contained Mode (Within Document Flow)
|
|
155
|
-
|
|
156
|
-
Use `bannerFullWidth={false}` to keep the banner within the document content area instead of full viewport width. This is useful when you have a sidebar or table of contents.
|
|
157
|
-
|
|
158
|
-
```mdx
|
|
159
|
-
<HeroBanner
|
|
160
|
-
bannerText="Course overview and learning objectives"
|
|
161
|
-
iconify="mdi:school"
|
|
162
|
-
bannerFullWidth={false}
|
|
163
|
-
/>
|
|
164
|
-
```
|
|
165
|
-
|
|
166
|
-
## Dot Cross Grid Animation
|
|
167
|
-
|
|
168
|
-
The dot cross grid creates an interactive background effect inspired by the HF Cross design. Move your mouse over the banner to see crosses appear around the cursor. The effect also includes idle animations along the edges when not interacting.
|
|
169
|
-
|
|
170
|
-
### Advanced Configuration
|
|
171
|
-
|
|
172
|
-
The following props allow fine-tuning of the dot cross grid animation. These are optional and typically don't need to be changed from their defaults.
|
|
173
|
-
|
|
174
|
-
| Prop | Type | Default | Description |
|
|
175
|
-
| ------------------------ | --------- | --------- | ----------------------------------------------------- |
|
|
176
|
-
| `dotCrossSize` | `number` | `2` | Size of each dot in pixels |
|
|
177
|
-
| `dotCrossGap` | `number` | `30` | Gap between dots in pixels |
|
|
178
|
-
| `pointerRadius` | `number` | `100` | Radius of pointer interaction area in pixels |
|
|
179
|
-
| `pointerInnerIntensity` | `number` | `1.0` | Opacity intensity for dots near pointer center |
|
|
180
|
-
| `pointerOuterIntensity` | `number` | `0.3` | Opacity intensity for dots at edge of pointer radius |
|
|
181
|
-
| `maxOpacity` | `number` | `1.0` | Maximum opacity for dots |
|
|
182
|
-
| `minOpacity` | `number` | `0.0` | Minimum opacity for dots |
|
|
183
|
-
| `randomOpacity` | `boolean` | `false` | Add random opacity variation to dots |
|
|
184
|
-
| `idleEnabled` | `boolean` | `true` | Enable idle edge animations |
|
|
185
|
-
| `idleAreaWidth` | `number` | `200` | Width of idle animation area from edges in pixels |
|
|
186
|
-
| `idleInterval` | `number` | `3000` | Time between idle animations in milliseconds |
|
|
187
|
-
| `idleIntensity` | `number` | `0.5` | Opacity intensity for idle animations |
|
|
188
|
-
|
|
189
|
-
### Example with Custom Animation Settings
|
|
190
|
-
|
|
191
|
-
```mdx
|
|
192
|
-
<HeroBanner
|
|
193
|
-
bannerText="Custom animated banner"
|
|
194
|
-
iconify="mdi:rocket"
|
|
195
|
-
enableDotCrossEffect={true}
|
|
196
|
-
dotCrossColor="#00ff00"
|
|
197
|
-
dotCrossSize={3}
|
|
198
|
-
dotCrossGap={40}
|
|
199
|
-
pointerRadius={150}
|
|
200
|
-
pointerInnerIntensity={1.0}
|
|
201
|
-
pointerOuterIntensity={0.2}
|
|
202
|
-
idleEnabled={true}
|
|
203
|
-
idleInterval={2000}
|
|
204
|
-
/>
|
|
205
|
-
```
|