@sp-days-framework/create-sp-days 1.0.2 → 1.0.4

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.
Files changed (19) hide show
  1. package/package.json +1 -1
  2. package/sp-days-framework-create-sp-days-1.0.3.tgz +0 -0
  3. package/templates/addon-resources/resources/interactive-tasks/creating-tasks.mdx +136 -174
  4. package/templates/addon-resources/resources/interactive-tasks/setup/advanced-configuration.mdx +124 -1
  5. package/templates/addon-resources/resources/interactive-tasks/setup/index.mdx +1 -55
  6. package/templates/addon-slidev/package.json +4 -4
  7. package/templates/page-course/docusaurus.config.ts +16 -4
  8. package/templates/page-course/package.json +2 -2
  9. package/templates/addon-resources/resources/frontpage-collection/components/Columns.mdx +0 -191
  10. package/templates/addon-resources/resources/frontpage-collection/components/ContentBlock.mdx +0 -126
  11. package/templates/addon-resources/resources/frontpage-collection/components/CourseFeature.mdx +0 -147
  12. package/templates/addon-resources/resources/frontpage-collection/components/FancyHeader.mdx +0 -76
  13. package/templates/addon-resources/resources/frontpage-collection/components/GetStarted.mdx +0 -222
  14. package/templates/addon-resources/resources/frontpage-collection/components/HeroBanner.mdx +0 -205
  15. package/templates/addon-resources/resources/frontpage-collection/components/IconContainer.mdx +0 -249
  16. package/templates/addon-resources/resources/frontpage-collection/components/Iconify.mdx +0 -228
  17. package/templates/addon-resources/resources/frontpage-collection/components/_category_.yml +0 -2
  18. package/templates/addon-resources/resources/frontpage-collection/index.mdx +0 -85
  19. package/templates/addon-resources/resources/frontpage-collection/setup/index.mdx +0 -185
@@ -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
- ```
@@ -1,249 +0,0 @@
1
- import Tabs from "@theme/Tabs";
2
- import TabItem from "@theme/TabItem";
3
- import {
4
- IconContainersSection,
5
- IconContainerBlock,
6
- } from "@sp-days-framework/docusaurus-frontpage-collection";
7
-
8
- # Icon Containers Block
9
-
10
- Display icon containers in a responsive grid with icons and links.
11
-
12
- <div className="preview">
13
- <div className="container">
14
- <IconContainersSection>
15
- <IconContainerBlock
16
- title="Git Knowledge"
17
- iconify="mdi:git"
18
- link="/resources"
19
- />
20
- <IconContainerBlock
21
- title="Terminal Skills"
22
- iconify="mdi:console"
23
- link="/resources"
24
- />
25
- </IconContainersSection>
26
- </div>
27
- </div>
28
-
29
- ## Features
30
-
31
- - Responsive grid layout
32
- - Icon support (Iconify or custom images)
33
- - Clickable cards with hover animations
34
- - Customizable icon and title colors
35
- - Optional animation disable
36
-
37
- ## Import
38
-
39
- <Tabs>
40
- <TabItem value="individual" label="Individual import" default>
41
- ```mdx
42
- import {
43
- IconContainersSection,
44
- IconContainerBlock,
45
- } from "@sp-days-framework/docusaurus-frontpage-collection";
46
- ```
47
- </TabItem>
48
- <TabItem value="default" label="Default import">
49
- ```mdx
50
- import IconContainersSection, { IconContainerBlock } from "@sp-days-framework/docusaurus-frontpage-collection/lib/components/IconContainer";
51
- ```
52
- </TabItem>
53
- </Tabs>
54
-
55
- ## Basic Usage
56
-
57
- ```mdx
58
- <IconContainersSection>
59
- <IconContainerBlock
60
- title="Programming Basics"
61
- iconify="mdi:code-braces"
62
- link="/docs/programming"
63
- />
64
- <IconContainerBlock
65
- title="Development Tools"
66
- iconify="mdi:tools"
67
- link="/docs/tools"
68
- />
69
- </IconContainersSection>
70
- ```
71
-
72
- ## Props
73
-
74
- ### IconContainersSection
75
-
76
- | Prop | Type | Default | Description |
77
- | ---------------- | ----------- | --------- | ----------------------------- |
78
- | `children` | `ReactNode` | required | IconContainerBlock components |
79
- | `minWidth` | `string` | `'200px'` | Minimum width for each block |
80
- | `maxItemsPerRow` | `string` | `'auto'` | Max items per row |
81
-
82
- ### IconContainerBlock
83
-
84
- | Prop | Type | Description |
85
- | ----------------- | ---------------------- | ---------------------------------------------- |
86
- | `id` | `string` | Optional unique identifier for the item |
87
- | `title` | `string` | Title of the item |
88
- | `iconify` | `IconifyConfig\|string`| Iconify icon name or configuration |
89
- | `customSvg` | `CustomSvgConfig` | Custom SVG files for light/dark themes (supports color override) |
90
- | `customImage` | `CustomImageConfig` | Custom image files (PNG/JPEG) for light/dark themes |
91
- | `iconColors` | `IconColorConfig` | Icon color overrides (light/dark/hover) |
92
- | `titleColors` | `TitleColorConfig` | Title color overrides (light/dark/hover) |
93
- | `disableAnimation`| `boolean` | Disable hover animation (default: false) |
94
- | `link` | `string` | Link URL when clicked |
95
-
96
- ## Examples
97
-
98
- ### With Iconify Icons
99
-
100
- ```mdx
101
- <IconContainersSection>
102
- <IconContainerBlock
103
- title="Linux Knowledge"
104
- iconify="mdi:linux"
105
- link="/docs/linux"
106
- />
107
- <IconContainerBlock
108
- title="Git Basics"
109
- iconify="mdi:git"
110
- link="/docs/git"
111
- />
112
- <IconContainerBlock
113
- title="Docker Basics"
114
- iconify="mdi:docker"
115
- link="/docs/docker"
116
- />
117
- </IconContainersSection>
118
- ```
119
-
120
- ### With Custom Colors
121
-
122
- ```mdx
123
- <IconContainersSection>
124
- <IconContainerBlock
125
- title="Linux Knowledge"
126
- iconify="mdi:linux"
127
- iconColors={{
128
- light: "#FCC624",
129
- lightHover: "#DB9D0C",
130
- dark: "#FFD65A",
131
- darkHover: "#FFE89E"
132
- }}
133
- titleColors={{
134
- light: "#333333",
135
- lightHover: "#FCC624"
136
- }}
137
- link="/docs/linux"
138
- />
139
- </IconContainersSection>
140
- ```
141
-
142
- ### With Custom SVG Images
143
-
144
- ```mdx
145
- <IconContainersSection>
146
- <IconContainerBlock
147
- title="VS Code"
148
- customSvg={{
149
- light: "img/vscode-light.svg",
150
- dark: "img/vscode-dark.svg",
151
- }}
152
- link="/docs/vscode"
153
- />
154
- </IconContainersSection>
155
- ```
156
-
157
- ### With Custom PNG/JPEG Images
158
-
159
- ```mdx
160
- <IconContainersSection>
161
- <IconContainerBlock
162
- title="VS Code"
163
- customImage={{
164
- light: "img/vscode-light.png",
165
- dark: "img/vscode-dark.png",
166
- }}
167
- link="/docs/vscode"
168
- />
169
- </IconContainersSection>
170
- ```
171
-
172
- ### Disable Animations
173
-
174
- ```mdx
175
- <IconContainersSection>
176
- <IconContainerBlock
177
- title="Static Item"
178
- iconify="mdi:information"
179
- disableAnimation={true}
180
- link="/docs/info"
181
- />
182
- </IconContainersSection>
183
- ```
184
-
185
- ### Custom Layout
186
-
187
- ```mdx
188
- <IconContainersSection minWidth="250px" maxItemsPerRow="2">
189
- <IconContainerBlock
190
- title="Requirement 1"
191
- iconify="mdi:check"
192
- link="/docs/req1"
193
- />
194
- <IconContainerBlock
195
- title="Requirement 2"
196
- iconify="mdi:check"
197
- link="/docs/req2"
198
- />
199
- <IconContainerBlock
200
- title="Requirement 3"
201
- iconify="mdi:check"
202
- link="/docs/req3"
203
- />
204
- <IconContainerBlock
205
- title="Requirement 4"
206
- iconify="mdi:check"
207
- link="/docs/req4"
208
- />
209
- </IconContainersSection>
210
- ```
211
-
212
- ## Complete Example
213
-
214
- ```mdx
215
- ---
216
- title: Course Icon Containers
217
- ---
218
-
219
- import {
220
- FancyHeader,
221
- IconContainersSection,
222
- IconContainerBlock,
223
- } from "@sp-days-framework/docusaurus-frontpage-collection";
224
-
225
- <FancyHeader>Icon Containers</FancyHeader>
226
-
227
- Before starting this course, make sure you have:
228
-
229
- <IconContainersSection>
230
- <IconContainerBlock
231
- id="programming"
232
- title="Programming Basics"
233
- iconify="mdi:code-braces"
234
- link="/docs/programming-basics"
235
- />
236
- <IconContainerBlock
237
- id="terminal"
238
- title="Terminal Usage"
239
- iconify="mdi:console"
240
- link="/docs/terminal"
241
- />
242
- <IconContainerBlock
243
- id="editor"
244
- title="Code Editor"
245
- iconify="mdi:file-code"
246
- link="/docs/editor-setup"
247
- />
248
- </IconContainersSection>
249
- ```