@sp-days-framework/create-sp-days 1.0.0
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/LICENSE +21 -0
- package/README.md +318 -0
- package/bin/index.js +86 -0
- package/lib/index.d.ts +20 -0
- package/lib/index.js +454 -0
- package/package.json +41 -0
- package/sp-days-framework-create-sp-days-1.0.0.tgz +0 -0
- package/templates/addon-resources/resources/frontpage-collection/components/Columns.mdx +191 -0
- package/templates/addon-resources/resources/frontpage-collection/components/ContentBlock.mdx +126 -0
- package/templates/addon-resources/resources/frontpage-collection/components/CourseFeature.mdx +147 -0
- package/templates/addon-resources/resources/frontpage-collection/components/FancyHeader.mdx +76 -0
- package/templates/addon-resources/resources/frontpage-collection/components/GetStarted.mdx +222 -0
- package/templates/addon-resources/resources/frontpage-collection/components/HeroBanner.mdx +205 -0
- package/templates/addon-resources/resources/frontpage-collection/components/IconContainer.mdx +249 -0
- package/templates/addon-resources/resources/frontpage-collection/components/Iconify.mdx +228 -0
- package/templates/addon-resources/resources/frontpage-collection/components/_category_.yml +2 -0
- package/templates/addon-resources/resources/frontpage-collection/index.mdx +85 -0
- package/templates/addon-resources/resources/frontpage-collection/setup/index.mdx +185 -0
- package/templates/addon-resources/resources/index.mdx +35 -0
- package/templates/addon-resources/resources/interactive-tasks/creating-tasks.mdx +292 -0
- package/templates/addon-resources/resources/interactive-tasks/examples/_category_.yml +3 -0
- package/templates/addon-resources/resources/interactive-tasks/examples/advanced-usage.mdx +304 -0
- package/templates/addon-resources/resources/interactive-tasks/examples/basic-usage.mdx +128 -0
- package/templates/addon-resources/resources/interactive-tasks/index.mdx +93 -0
- package/templates/addon-resources/resources/interactive-tasks/setup/advanced-configuration.mdx +150 -0
- package/templates/addon-resources/resources/interactive-tasks/setup/index.mdx +174 -0
- package/templates/addon-resources/resources/interactive-tasks/task-progression.mdx +140 -0
- package/templates/addon-resources/resources/slidev-integration/index.mdx +106 -0
- package/templates/addon-resources/resources/slidev-integration/setup/advanced-configuration.mdx +144 -0
- package/templates/addon-resources/resources/slidev-integration/setup/index.mdx +200 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/index.mdx +105 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/_category_.yml +2 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/content/_category_.yml +2 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/content/center.mdx +33 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/content/default.mdx +59 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/content/full.mdx +49 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/image/_category_.yml +2 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/image/image-left.mdx +37 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/image/image-right.mdx +37 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/image/image.mdx +56 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/multi-column/_category_.yml +2 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/multi-column/three-cols-header.mdx +49 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/multi-column/three-cols.mdx +47 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/multi-column/two-cols-header.mdx +43 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/multi-column/two-cols.mdx +38 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/section/_category_.yml +2 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/section/cover.mdx +43 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/section/end.mdx +33 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/section/intro.mdx +49 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/section/section.mdx +41 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/special/_category_.yml +2 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/special/about-me.mdx +92 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/special/fact.mdx +47 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/special/quote.mdx +27 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/layouts/special/statement.mdx +28 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/setup/advanced-configuration.mdx +79 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/setup/index.mdx +104 -0
- package/templates/addon-resources/resources/sykehuspartner-theme/syntax-and-icons.mdx +89 -0
- package/templates/addon-slidev/package.json +54 -0
- package/templates/addon-slidev/slidev/creating-your-first-slidev.md +301 -0
- package/templates/addon-slidev/slidev/slidev-theme-sykehuspartner.md +403 -0
- package/templates/page-course/README.md +152 -0
- package/templates/page-course/course/index.mdx +7 -0
- package/templates/page-course/course/placeholder-advanced-usage.mdx +304 -0
- package/templates/page-course/course/placeholder-basic-usage.mdx +128 -0
- package/templates/page-course/docusaurus.config.ts +171 -0
- package/templates/page-course/example-github-pages.yml +66 -0
- package/templates/page-course/gitignore +20 -0
- package/templates/page-course/package.json +51 -0
- package/templates/page-course/src/css/sp-days-theme.scss +297 -0
- package/templates/page-course/src/pages/index.mdx +165 -0
- package/templates/page-course/static/.nojekyll +0 -0
- package/templates/page-course/static/img/favicon-navbar/github.svg +3 -0
- package/templates/page-course/static/img/favicon-navbar/sorost-logo-dark.svg +24 -0
- package/templates/page-course/static/img/favicon-navbar/sorost-logo-light.svg +24 -0
- package/templates/page-course/static/img/footer/sykehuspartner-dark.svg +37 -0
- package/templates/page-course/static/img/footer/sykehuspartner-light.svg +37 -0
- package/templates/page-course/static/img/sidebar/docusaurus.svg +17 -0
- package/templates/page-course/static/img/sidebar/slidev.svg +22 -0
- package/templates/page-course/static/img/sp-days-logo-color-dark.svg +70 -0
- package/templates/page-course/static/img/sp-days-logo-color-light.svg +70 -0
- package/templates/page-course/static/img/sp-days-logo-filled-invert.svg +11 -0
- package/templates/page-course/static/img/sp-days-logo-filled.svg +11 -0
- package/templates/page-course/static/img/sp-days-logo-outline.svg +19 -0
- package/templates/page-course/static/img/sp-days-plugin-color-dark.svg +57 -0
- package/templates/page-course/static/img/sp-days-plugin-color-light.svg +53 -0
- package/templates/page-course/tsconfig.json +8 -0
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
import Tabs from "@theme/Tabs";
|
|
2
|
+
import TabItem from "@theme/TabItem";
|
|
3
|
+
import { Block } from "@sp-days-framework/docusaurus-frontpage-collection";
|
|
4
|
+
|
|
5
|
+
# Content Block
|
|
6
|
+
|
|
7
|
+
A simple styled block container for highlighting content.
|
|
8
|
+
|
|
9
|
+
<div className="preview">
|
|
10
|
+
<div className="container">
|
|
11
|
+
<Block>
|
|
12
|
+
### Example Block
|
|
13
|
+
|
|
14
|
+
This is a live example of the Block component with hover effect.
|
|
15
|
+
|
|
16
|
+
- **Feature 1**: Styled container
|
|
17
|
+
- **Feature 2**: Hover animation
|
|
18
|
+
- **Feature 3**: Perfect for side content
|
|
19
|
+
</Block>
|
|
20
|
+
</div>
|
|
21
|
+
</div>
|
|
22
|
+
|
|
23
|
+
## Features
|
|
24
|
+
|
|
25
|
+
- Hover effect
|
|
26
|
+
- Works great in columns or standalone
|
|
27
|
+
|
|
28
|
+
## Import
|
|
29
|
+
|
|
30
|
+
<Tabs>
|
|
31
|
+
<TabItem value="individual" label="Individual import" default>
|
|
32
|
+
```mdx
|
|
33
|
+
import { Block } from "@sp-days-framework/docusaurus-frontpage-collection";
|
|
34
|
+
```
|
|
35
|
+
</TabItem>
|
|
36
|
+
<TabItem value="default" label="Default import">
|
|
37
|
+
```mdx
|
|
38
|
+
import Block from "@sp-days-framework/docusaurus-frontpage-collection/lib/components/Block";
|
|
39
|
+
```
|
|
40
|
+
</TabItem>
|
|
41
|
+
</Tabs>
|
|
42
|
+
|
|
43
|
+
## Basic Usage
|
|
44
|
+
|
|
45
|
+
```mdx
|
|
46
|
+
<Block>
|
|
47
|
+
## Quick Info
|
|
48
|
+
|
|
49
|
+
- **Duration**: 4 weeks
|
|
50
|
+
- **Effort**: 10 hours/week
|
|
51
|
+
- **Level**: Intermediate
|
|
52
|
+
</Block>
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Props
|
|
56
|
+
|
|
57
|
+
| Prop | Type | Description |
|
|
58
|
+
| ----------- | ----------- | ---------------------- |
|
|
59
|
+
| `className` | `string` | Additional CSS classes |
|
|
60
|
+
| `children` | `ReactNode` | Markdown content |
|
|
61
|
+
|
|
62
|
+
## Examples
|
|
63
|
+
|
|
64
|
+
### Simple Block
|
|
65
|
+
|
|
66
|
+
```mdx
|
|
67
|
+
<Block>
|
|
68
|
+
### Important Note
|
|
69
|
+
|
|
70
|
+
Remember to complete all iconContainers before starting.
|
|
71
|
+
</Block>
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### With Custom Class
|
|
75
|
+
|
|
76
|
+
```mdx
|
|
77
|
+
<Block className="my-custom-class">Custom styled content</Block>
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### In Columns
|
|
81
|
+
|
|
82
|
+
```mdx
|
|
83
|
+
import {
|
|
84
|
+
Columns,
|
|
85
|
+
Left,
|
|
86
|
+
Right,
|
|
87
|
+
Block,
|
|
88
|
+
} from "@sp-days-framework/docusaurus-frontpage-collection";
|
|
89
|
+
|
|
90
|
+
<Columns leftRatio="65">
|
|
91
|
+
<Left>
|
|
92
|
+
Main content goes here...
|
|
93
|
+
</Left>
|
|
94
|
+
<Right>
|
|
95
|
+
<Block>
|
|
96
|
+
### Course Stats
|
|
97
|
+
|
|
98
|
+
- 1,000+ students
|
|
99
|
+
- 4.8/5 rating
|
|
100
|
+
- Updated monthly
|
|
101
|
+
</Block>
|
|
102
|
+
</Right>
|
|
103
|
+
</Columns>
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### Multiple Blocks
|
|
107
|
+
|
|
108
|
+
```mdx
|
|
109
|
+
<Block>
|
|
110
|
+
### Module 1
|
|
111
|
+
|
|
112
|
+
Introduction to Docker
|
|
113
|
+
</Block>
|
|
114
|
+
|
|
115
|
+
<Block>
|
|
116
|
+
### Module 2
|
|
117
|
+
|
|
118
|
+
Container Management
|
|
119
|
+
</Block>
|
|
120
|
+
|
|
121
|
+
<Block>
|
|
122
|
+
### Module 3
|
|
123
|
+
|
|
124
|
+
Image Building
|
|
125
|
+
</Block>
|
|
126
|
+
```
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
import Tabs from "@theme/Tabs";
|
|
2
|
+
import TabItem from "@theme/TabItem";
|
|
3
|
+
import {
|
|
4
|
+
CourseFeature,
|
|
5
|
+
Included,
|
|
6
|
+
NotIncluded,
|
|
7
|
+
} from "@sp-days-framework/docusaurus-frontpage-collection";
|
|
8
|
+
|
|
9
|
+
# Course Feature Section
|
|
10
|
+
|
|
11
|
+
A card-based component for displaying what's included and not included in your course.
|
|
12
|
+
|
|
13
|
+
<div className="preview">
|
|
14
|
+
<div className="container" style={{ width: '-webkit-fill-available'}}>
|
|
15
|
+
<CourseFeature>
|
|
16
|
+
<Included>
|
|
17
|
+
- **Core Concepts**: Learn the fundamentals
|
|
18
|
+
- **Hands-on Labs**: Practice with real examples
|
|
19
|
+
- **Certificate**: Earn a completion certificate
|
|
20
|
+
</Included>
|
|
21
|
+
<NotIncluded>
|
|
22
|
+
- **Advanced Topics**: Covered in advanced course
|
|
23
|
+
- **1-on-1 Mentoring**: Available as add-on
|
|
24
|
+
</NotIncluded>
|
|
25
|
+
</CourseFeature>
|
|
26
|
+
</div>
|
|
27
|
+
</div>
|
|
28
|
+
|
|
29
|
+
## Features
|
|
30
|
+
|
|
31
|
+
- Side-by-side included/not included cards
|
|
32
|
+
- Built-in success/danger colored icons
|
|
33
|
+
- Hover animations on cards and icons
|
|
34
|
+
- Support for custom icons
|
|
35
|
+
- Responsive layout
|
|
36
|
+
- Equal height cards
|
|
37
|
+
|
|
38
|
+
## Import
|
|
39
|
+
|
|
40
|
+
<Tabs>
|
|
41
|
+
<TabItem value="individual" label="Individual import" default>
|
|
42
|
+
```mdx
|
|
43
|
+
import {
|
|
44
|
+
CourseFeature,
|
|
45
|
+
Included,
|
|
46
|
+
NotIncluded,
|
|
47
|
+
} from "@sp-days-framework/docusaurus-frontpage-collection";
|
|
48
|
+
```
|
|
49
|
+
</TabItem>
|
|
50
|
+
<TabItem value="default" label="Default import">
|
|
51
|
+
```mdx
|
|
52
|
+
import CourseFeature, { Included, NotIncluded } from "@sp-days-framework/docusaurus-frontpage-collection/lib/components/CourseFeature";
|
|
53
|
+
```
|
|
54
|
+
</TabItem>
|
|
55
|
+
</Tabs>
|
|
56
|
+
|
|
57
|
+
## Basic Usage
|
|
58
|
+
|
|
59
|
+
```mdx
|
|
60
|
+
<CourseFeature>
|
|
61
|
+
<Included>
|
|
62
|
+
- **Docker Fundamentals**: Core concepts and architecture
|
|
63
|
+
- **Container Management**: Creating and managing containers
|
|
64
|
+
- **Image Building**: Building custom images
|
|
65
|
+
</Included>
|
|
66
|
+
<NotIncluded>
|
|
67
|
+
- **Kubernetes**: Covered in advanced course
|
|
68
|
+
- **CI/CD Pipelines**: Separate course available
|
|
69
|
+
</NotIncluded>
|
|
70
|
+
</CourseFeature>
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## Props
|
|
74
|
+
|
|
75
|
+
### CourseFeature
|
|
76
|
+
|
|
77
|
+
| Prop | Type | Default | Description |
|
|
78
|
+
| -------------------------- | ---------------------- | ---------- | ------------------------------------------------- |
|
|
79
|
+
| `children` | `ReactNode` | required | Included/NotIncluded components or direct content |
|
|
80
|
+
| `iconifyIncluded` | `IconifyConfig\|string`| Check icon | Iconify icon for included section |
|
|
81
|
+
| `customSvgIncluded` | `CustomSvgConfig` | - | Custom SVG file for included section (supports color override) |
|
|
82
|
+
| `customImageIncluded` | `CustomImageConfig` | - | Custom image file (PNG/JPEG) for included section |
|
|
83
|
+
| `iconifyNotIncluded` | `IconifyConfig\|string`| Cross icon | Iconify icon for not included section |
|
|
84
|
+
| `customSvgNotIncluded` | `CustomSvgConfig` | - | Custom SVG file for not included section (supports color override) |
|
|
85
|
+
| `customImageNotIncluded` | `CustomImageConfig` | - | Custom image file (PNG/JPEG) for not included section |
|
|
86
|
+
| `included` | `boolean` | `true` | Legacy prop for single card mode |
|
|
87
|
+
|
|
88
|
+
### Included / NotIncluded
|
|
89
|
+
|
|
90
|
+
| Prop | Type | Description |
|
|
91
|
+
| ---------- | ----------- | ---------------- |
|
|
92
|
+
| `children` | `ReactNode` | Markdown content |
|
|
93
|
+
|
|
94
|
+
## Examples
|
|
95
|
+
|
|
96
|
+
### Standard Usage
|
|
97
|
+
|
|
98
|
+
```mdx
|
|
99
|
+
<CourseFeature>
|
|
100
|
+
<Included>
|
|
101
|
+
- **Core Concepts**: Fundamentals
|
|
102
|
+
- **Hands-on Labs**: Practical exercises
|
|
103
|
+
- **Real Examples**: Production code
|
|
104
|
+
</Included>
|
|
105
|
+
<NotIncluded>
|
|
106
|
+
- **Advanced Topics**: In advanced course
|
|
107
|
+
- **Certification**: Available separately
|
|
108
|
+
</NotIncluded>
|
|
109
|
+
</CourseFeature>
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### With Custom Icons
|
|
113
|
+
|
|
114
|
+
```mdx
|
|
115
|
+
<CourseFeature
|
|
116
|
+
iconifyIncluded="mdi:check-circle"
|
|
117
|
+
iconifyNotIncluded="mdi:close-circle"
|
|
118
|
+
>
|
|
119
|
+
<Included>
|
|
120
|
+
Content...
|
|
121
|
+
</Included>
|
|
122
|
+
<NotIncluded>
|
|
123
|
+
Not included...
|
|
124
|
+
</NotIncluded>
|
|
125
|
+
</CourseFeature>
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### Only Included
|
|
129
|
+
|
|
130
|
+
```mdx
|
|
131
|
+
<CourseFeature>
|
|
132
|
+
<Included>
|
|
133
|
+
- Everything you need
|
|
134
|
+
- Lifetime access
|
|
135
|
+
- Free updates
|
|
136
|
+
</Included>
|
|
137
|
+
</CourseFeature>
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
## Default Icons
|
|
141
|
+
|
|
142
|
+
The component uses inline SVG icons with CSS variable colors:
|
|
143
|
+
|
|
144
|
+
- **Included**: Green check circle (`var(--ifm-color-success)`)
|
|
145
|
+
- **Not Included**: Red cross circle (`var(--ifm-color-danger)`)
|
|
146
|
+
|
|
147
|
+
These automatically adapt to your Docusaurus theme colors.
|
|
@@ -0,0 +1,76 @@
|
|
|
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
|
+
```
|
|
@@ -0,0 +1,222 @@
|
|
|
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
|
+
```
|