@sp-days-framework/create-sp-days 1.0.4 → 1.1.0-beta2

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 (75) hide show
  1. package/README.md +14 -0
  2. package/bin/index.js +2 -0
  3. package/docs/advanced-config.mdx +412 -0
  4. package/docs/changelog.mdx +129 -0
  5. package/docs/index.mdx +206 -0
  6. package/docs/install.mdx +199 -0
  7. package/docs/sidebar-sections.mdx +268 -0
  8. package/docs/sp-days-plugin-color-light.svg +53 -0
  9. package/lib/.tsbuildinfo +1 -0
  10. package/lib/.tsbuildinfo-build +1 -0
  11. package/lib/index.d.ts +1 -0
  12. package/lib/index.js +36 -7
  13. package/package.json +31 -7
  14. package/publish-package-docs.js +12 -0
  15. package/templates/addon-resources/resources/api-reference.mdx +132 -0
  16. package/templates/addon-resources/resources/best-practice.mdx +407 -0
  17. package/templates/addon-resources/resources/cheat-sheet.mdx +120 -0
  18. package/templates/addon-resources/resources/cli-reference.mdx +280 -0
  19. package/templates/addon-resources/resources/configuration-guide.mdx +211 -0
  20. package/templates/addon-resources/resources/environment-setup.mdx +317 -0
  21. package/templates/addon-resources/resources/faq.mdx +146 -0
  22. package/templates/addon-resources/resources/glossary.mdx +78 -0
  23. package/templates/addon-resources/resources/index.mdx +67 -16
  24. package/templates/addon-resources/resources/quick-start.mdx +193 -0
  25. package/templates/addon-resources/resources/troubleshooting.mdx +263 -0
  26. package/templates/addon-resources/resources/useful-links.mdx +61 -0
  27. package/templates/page-course/README.md +87 -0
  28. package/templates/page-course/docusaurus.config.ts +103 -10
  29. package/templates/page-course/package.json +12 -2
  30. package/templates/page-course/sidebarSections.js +118 -0
  31. package/templates/page-course/src/css/sp-days-theme.scss +428 -211
  32. package/tsconfig.base.client.json +10 -0
  33. package/tsconfig.base.json +71 -0
  34. package/tsconfig.build.json +9 -0
  35. package/sp-days-framework-create-sp-days-1.0.3.tgz +0 -0
  36. package/templates/addon-resources/resources/interactive-tasks/creating-tasks.mdx +0 -254
  37. package/templates/addon-resources/resources/interactive-tasks/examples/_category_.yml +0 -3
  38. package/templates/addon-resources/resources/interactive-tasks/examples/advanced-usage.mdx +0 -304
  39. package/templates/addon-resources/resources/interactive-tasks/examples/basic-usage.mdx +0 -128
  40. package/templates/addon-resources/resources/interactive-tasks/index.mdx +0 -93
  41. package/templates/addon-resources/resources/interactive-tasks/setup/advanced-configuration.mdx +0 -273
  42. package/templates/addon-resources/resources/interactive-tasks/setup/index.mdx +0 -120
  43. package/templates/addon-resources/resources/interactive-tasks/task-progression.mdx +0 -140
  44. package/templates/addon-resources/resources/slidev-integration/index.mdx +0 -106
  45. package/templates/addon-resources/resources/slidev-integration/setup/advanced-configuration.mdx +0 -144
  46. package/templates/addon-resources/resources/slidev-integration/setup/index.mdx +0 -200
  47. package/templates/addon-resources/resources/sykehuspartner-theme/index.mdx +0 -105
  48. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/_category_.yml +0 -2
  49. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/content/_category_.yml +0 -2
  50. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/content/center.mdx +0 -33
  51. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/content/default.mdx +0 -59
  52. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/content/full.mdx +0 -49
  53. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/image/_category_.yml +0 -2
  54. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/image/image-left.mdx +0 -37
  55. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/image/image-right.mdx +0 -37
  56. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/image/image.mdx +0 -56
  57. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/multi-column/_category_.yml +0 -2
  58. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/multi-column/three-cols-header.mdx +0 -49
  59. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/multi-column/three-cols.mdx +0 -47
  60. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/multi-column/two-cols-header.mdx +0 -43
  61. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/multi-column/two-cols.mdx +0 -38
  62. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/section/_category_.yml +0 -2
  63. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/section/cover.mdx +0 -43
  64. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/section/end.mdx +0 -33
  65. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/section/intro.mdx +0 -49
  66. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/section/section.mdx +0 -41
  67. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/special/_category_.yml +0 -2
  68. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/special/about-me.mdx +0 -92
  69. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/special/fact.mdx +0 -47
  70. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/special/quote.mdx +0 -27
  71. package/templates/addon-resources/resources/sykehuspartner-theme/layouts/special/statement.mdx +0 -28
  72. package/templates/addon-resources/resources/sykehuspartner-theme/setup/advanced-configuration.mdx +0 -79
  73. package/templates/addon-resources/resources/sykehuspartner-theme/setup/index.mdx +0 -104
  74. package/templates/addon-resources/resources/sykehuspartner-theme/syntax-and-icons.mdx +0 -89
  75. package/templates/addon-slidev/package.json +0 -54
@@ -1,92 +0,0 @@
1
- ---
2
- title: About Me
3
- description: Personal introduction and profile layout
4
- ---
5
-
6
- # About Me Layout
7
-
8
- The `about-me` layout is designed for introducing speakers, instructors, or team members. It supports profile images and detailed information in a professional format.
9
-
10
- ## When to Use
11
-
12
- - Speaker introductions
13
- - Instructor profiles
14
- - Team member presentations
15
- - Personal bio slides
16
-
17
- ## Parameters
18
-
19
- | Parameter | Type | Default | Description |
20
- |-----------|------|---------|-------------|
21
- | `name` | string | - | Person's full name |
22
- | `jobTitle` | string | - | Job title or role |
23
- | `department` | string | - | Department or team (optional) |
24
- | `description` | string | - | Brief bio or description |
25
- | `email` | string | - | Email address (optional) |
26
- | `linkedin` | string | - | LinkedIn username (optional) |
27
- | `imageSrc` | string | - | Profile photo URL |
28
- | `imageShape` | string | `'rectangle'` | Shape: `'circle'` or `'rectangle'` |
29
- | `imageSize` | string | `'100%'` | Image size percentage |
30
- | `imagePosition` | string | `'right'` | Position: `'left'` or `'right'` |
31
- | `logo` | boolean | `false` | Show/hide logo |
32
-
33
- ## Basic Example (Image Right)
34
-
35
- ```markdown
36
- ---
37
- layout: about-me
38
- name: Jane Developer
39
- jobTitle: "Senior DevOps Engineer"
40
- department: "Cloud Platform Team"
41
- description: "Specialist in container technologies with 10 years of experience in cloud-native solutions"
42
- email: "jane.developer@example.com"
43
- linkedin: "janedev"
44
- imageSrc: /jane-profile.jpg
45
- imageShape: circle
46
- imagePosition: right
47
- ---
48
- ```
49
-
50
- ## Image on Left
51
-
52
- ```markdown
53
- ---
54
- layout: about-me
55
- name: John Smith
56
- jobTitle: "Docker Expert"
57
- department: "Infrastructure Team"
58
- description: "Passionate about automation and infrastructure as code"
59
- email: "john.smith@example.com"
60
- imageSrc: /john-profile.jpg
61
- imageShape: circle
62
- imagePosition: left
63
- ---
64
- ```
65
-
66
- ## Without Image
67
-
68
- ```markdown
69
- ---
70
- layout: about-me
71
- name: Alex Johnson
72
- jobTitle: "Kubernetes Architect"
73
- description: "Cloud native enthusiast and open source contributor"
74
- email: "alex@example.com"
75
- linkedin: "alexj"
76
- ---
77
- ```
78
-
79
- ## Rectangle Image
80
-
81
- ```markdown
82
- ---
83
- layout: about-me
84
- name: Maria Garcia
85
- jobTitle: "DevOps Lead"
86
- description: "Leading teams to adopt containerization and modern deployment practices"
87
- imageSrc: /maria.jpg
88
- imageShape: rectangle
89
- imageSize: 85%
90
- imagePosition: left
91
- ---
92
- ```
@@ -1,47 +0,0 @@
1
- ---
2
- title: Fact
3
- description: Emphasize key statistics and facts
4
- ---
5
-
6
- # Fact Layout
7
-
8
- The `fact` layout is designed to emphasize important statistics, numbers, or key facts. Content is vertically centered for maximum impact.
9
-
10
- ## When to Use
11
-
12
- - Highlighting statistics
13
- - Emphasizing key numbers
14
- - Important facts or findings
15
- - Data-driven points
16
-
17
- ## Parameters
18
-
19
- | Parameter | Type | Default | Description |
20
- |-----------|------|---------|-------------|
21
- | `logo` | boolean | `true` | Show/hide the logo |
22
-
23
- ## Basic Example
24
-
25
- ```markdown
26
- ---
27
- layout: fact
28
- ---
29
-
30
- # 95%
31
-
32
- ## of Fortune 500 companies use containers
33
- ```
34
-
35
- ## With Context
36
-
37
- ```markdown
38
- ---
39
- layout: fact
40
- ---
41
-
42
- # 10x Faster
43
-
44
- ## Deployment speed with Docker
45
-
46
- Source: DevOps Survey 2024
47
- ```
@@ -1,27 +0,0 @@
1
- ---
2
- title: Quote
3
- description: Display quotes with attribution
4
- ---
5
-
6
- # Quote Layout
7
-
8
- The `quote` layout is designed for displaying quotes with proper attribution.
9
-
10
- ## Parameters
11
-
12
- | Parameter | Type | Default | Description |
13
- |-----------|------|---------|-------------|
14
- | `logo` | boolean | `false` | Show/hide logo |
15
-
16
- ## Basic Example
17
-
18
- ```markdown
19
- ---
20
- layout: quote
21
- ---
22
-
23
- # "The best way to predict the future is to create it."
24
-
25
- ## Alan Kay
26
- ### Computer Scientist
27
- ```
@@ -1,28 +0,0 @@
1
- ---
2
- title: Statement
3
- description: Bold statement slide for impact
4
- ---
5
-
6
- # Statement Layout
7
-
8
- The `statement` layout emphasizes bold statements or key messages with centered text.
9
-
10
- ## Parameters
11
-
12
- | Parameter | Type | Default | Description |
13
- |-----------|------|---------|-------------|
14
- | `logo` | boolean | `true` | Show/hide logo |
15
-
16
- ## Basic Example
17
-
18
- ```markdown
19
- ---
20
- layout: statement
21
- ---
22
-
23
- # "Infrastructure as Code"
24
-
25
- ## The Future of Operations
26
-
27
- Treating infrastructure like software
28
- ```
@@ -1,79 +0,0 @@
1
- ---
2
- title: Advanced
3
- sidebar_position: 2
4
- ---
5
-
6
- import Tabs from "@theme/Tabs";
7
- import TabItem from "@theme/TabItem";
8
-
9
- # Advanced Configuration
10
-
11
- ## Common Layout Parameters
12
-
13
- Most layouts support these common parameters:
14
-
15
- | Parameter | Type | Default | Description |
16
- |-----------|------|---------|-------------|
17
- | `logo` | boolean | varies | Show/hide the logo |
18
- | `textAlignment` | string | `'center'` | Vertical alignment: `'top'`, `'center'`, `'bottom'` |
19
-
20
- ## Image Configuration Parameters
21
-
22
- Layouts with images support:
23
-
24
- | Parameter | Type | Default | Description |
25
- |-----------|------|---------|-------------|
26
- | `imageSrc` | string | - | Image URL or path |
27
- | `imageRatio` | string | `'50%'` | Image width percentage |
28
- | `imageScale` | string | `'100%'` | Image size within container |
29
- | `imageAlign` | string | `'center'` | Image alignment |
30
- | `imagePosition` | string | varies | Position: `'left'` or `'right'` |
31
- | `imageBackgroundMode` | boolean | varies | Background vs foreground mode |
32
-
33
- ## Global Theme Configuration
34
-
35
- Configure theme-wide settings in your presentation frontmatter:
36
-
37
- ```markdown title="slidev/presentation.md"
38
- ---
39
- theme: "@sp-days-framework/slidev-theme-sykehuspartner"
40
- title: My Presentation
41
- highlighter: shiki
42
- lineNumbers: true
43
- drawings:
44
- persist: false
45
- transition: slide-left
46
- ---
47
- ```
48
-
49
- ### Available Global Options
50
-
51
- | Option | Type | Default | Description |
52
- |--------|------|---------|-------------|
53
- | `highlighter` | string | `'shiki'` | Code highlighter: `'shiki'` or `'prism'` |
54
- | `lineNumbers` | boolean | `false` | Show line numbers in code blocks |
55
- | `drawings` | object | - | Drawing/annotation settings |
56
- | `transition` | string | `'fade'` | Slide transition effect |
57
- | `colorSchema` | string | `'auto'` | Color scheme: `'auto'`, `'dark'`, `'light'` |
58
-
59
- See [Slidev configuration](https://sli.dev/custom/#frontmatter-configures) for all options.
60
-
61
- ## Custom Styling
62
-
63
- Override theme styles with custom CSS:
64
-
65
- ```markdown title="slidev/presentation.md"
66
- ---
67
- theme: "@sp-days-framework/slidev-theme-sykehuspartner"
68
- ---
69
-
70
- <style>
71
- .slidev-layout.cover {
72
- background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
73
- }
74
-
75
- h1 {
76
- font-size: 3rem !important;
77
- }
78
- </style>
79
- ```
@@ -1,104 +0,0 @@
1
- ---
2
- sidebar_position: 1
3
- ---
4
-
5
- import Tabs from "@theme/Tabs";
6
- import TabItem from "@theme/TabItem";
7
-
8
- # Setup
9
-
10
- :::tip[Already Included]
11
- If you're using `@sp-days-framework/create-sp-days`, the Sykehuspartner Slidev Theme is already installed and configured. You can start creating presentations right away!
12
- :::
13
-
14
- ## Installation
15
-
16
- Install the theme using your preferred package manager:
17
-
18
- <Tabs>
19
- <TabItem value="npm" label="npm" default>
20
- ```bash
21
- npm install @sp-days-framework/slidev-theme-sykehuspartner
22
- ```
23
- </TabItem>
24
- <TabItem value="yarn" label="Yarn">
25
- ```bash
26
- yarn add @sp-days-framework/slidev-theme-sykehuspartner
27
- ```
28
- </TabItem>
29
- </Tabs>
30
-
31
- Configure the theme in your presentation's frontmatter:
32
-
33
- ```markdown title="slidev/presentation.md"
34
- ---
35
- theme: "@sp-days-framework/slidev-theme-sykehuspartner"
36
- title: My Presentation
37
- layout: cover
38
- ---
39
-
40
- # My Presentation Title
41
- ## Subtitle Goes Here
42
-
43
- ---
44
-
45
- # First Content Slide
46
- Your content here...
47
- ```
48
-
49
- The theme is now active and all 18 layouts are available.
50
-
51
- ## Configuration
52
-
53
- ### Basic Theme Setup
54
-
55
- Configure the theme in your presentation's frontmatter:
56
-
57
- ```markdown title="slidev/presentation.md"
58
- ---
59
- theme: "@sp-days-framework/slidev-theme-sykehuspartner"
60
- title: My Presentation
61
- layout: cover
62
- ---
63
-
64
- # My Presentation
65
- ## Subtitle
66
- ```
67
-
68
- ### Using with Docusaurus Plugin
69
-
70
- When using with `@sp-days-framework/docusaurus-plugin-slidev`, set the theme globally or per-presentation:
71
-
72
- **Global Theme:**
73
-
74
- ```js title="docusaurus.config.js"
75
- module.exports = {
76
- plugins: [
77
- [
78
- "@sp-days-framework/docusaurus-plugin-slidev",
79
- {
80
- theme: "@sp-days-framework/slidev-theme-sykehuspartner",
81
- },
82
- ],
83
- ],
84
- };
85
- ```
86
-
87
- **Per-Presentation Override:**
88
-
89
- ```markdown title="slidev/my-presentation.md"
90
- ---
91
- theme: "@sp-days-framework/slidev-theme-sykehuspartner"
92
- title: My Presentation
93
- ---
94
- ```
95
-
96
- See [Slidev Integration](../../slidev-integration/index.mdx) for plugin documentation.
97
-
98
- ### Running Development Server
99
-
100
- Run Slidev to preview your presentation with hot-reload:
101
-
102
- ```bash
103
- npm run slidev ./slidev/presentation.md
104
- ```
@@ -1,89 +0,0 @@
1
- ---
2
- title: Syntax Highlighting & Icons
3
- sidebar_position: 1
4
- ---
5
-
6
- import Tabs from "@theme/Tabs";
7
- import TabItem from "@theme/TabItem";
8
-
9
- # Syntax Highlighting & Icons
10
-
11
- ## Syntax Highlighting
12
-
13
- The theme includes built-in syntax highlighting for 30+ programming languages powered by Shiki.
14
-
15
- ### Supported Languages
16
-
17
- - HTML, CSS, JavaScript, TypeScript, JSX, TSX, Vue, MDX
18
- - Python, Java, C#, Go, Rust, Ruby, PHP
19
- - Docker, Terraform, YAML, TOML, Shell Script, PowerShell
20
- - SQL, JSON, JSONC, CSV, GraphQL
21
- - Markdown, LaTeX, XML
22
- - NGINX, INI, .env, Git commit/rebase, CODEOWNERS
23
- - Lua, HCL, SCSS, Sass
24
-
25
- ### Basic Usage
26
-
27
- Use standard code blocks with language identifiers:
28
-
29
- ````markdown
30
- ```python
31
- def hello_world():
32
- print("Hello, Slidev!")
33
- ```
34
-
35
- ```javascript
36
- const greeting = "Hello, World!";
37
- console.log(greeting);
38
- ```
39
-
40
- ```bash
41
- docker run -d -p 8080:80 nginx
42
- ```
43
- ````
44
-
45
- ## Icon Support
46
-
47
- The theme includes the VSCode Icons collection for technical presentations.
48
-
49
- ### Icon Discovery
50
-
51
- Icons are automatically scanned from your markdown files and included in the build. Browse the full collection at [VSCode Icons](https://github.com/vscode-icons/vscode-icons).
52
-
53
- ### Using VSCode Icons
54
-
55
- Use the tilde syntax to include icons inline:
56
-
57
- ```markdown
58
- ---
59
- layout: default
60
- ---
61
-
62
- # Technologies Used
63
-
64
- ~i-vscode-icons:file-type-docker~ Docker
65
-
66
- ~i-vscode-icons:file-type-python~ Python
67
-
68
- ~i-vscode-icons:file-type-typescript-official~ TypeScript
69
-
70
- ~i-vscode-icons:file-type-kubernetes~ Kubernetes
71
- ```
72
-
73
- ### Common VSCode Icons
74
-
75
- | Icon Syntax | Description |
76
- |-------------|-------------|
77
- | `~i-vscode-icons:file-type-docker~` | Docker |
78
- | `~i-vscode-icons:file-type-python~` | Python |
79
- | `~i-vscode-icons:file-type-typescript-official~` | TypeScript |
80
- | `~i-vscode-icons:file-type-javascript-official~` | JavaScript |
81
- | `~i-vscode-icons:file-type-vue~` | Vue.js |
82
- | `~i-vscode-icons:file-type-react~` | React |
83
- | `~i-vscode-icons:file-type-kubernetes~` | Kubernetes |
84
- | `~i-vscode-icons:file-type-terraform~` | Terraform |
85
- | `~i-vscode-icons:file-type-yaml~` | YAML |
86
- | `~i-vscode-icons:file-type-json~` | JSON |
87
- | `~i-vscode-icons:file-type-markdown~` | Markdown |
88
- | `~i-vscode-icons:file-type-git~` | Git |
89
-
@@ -1,54 +0,0 @@
1
- {
2
- "name": "<%= projectName %>",
3
- "version": "0.0.0",
4
- "private": true,
5
- "scripts": {
6
- "docusaurus": "docusaurus",
7
- "start": "docusaurus start",
8
- "build": "docusaurus build",
9
- "swizzle": "docusaurus swizzle",
10
- "deploy": "docusaurus deploy",
11
- "clear": "docusaurus clear",
12
- "serve": "docusaurus serve",
13
- "slidev": "slidev",
14
- "write-translations": "docusaurus write-translations",
15
- "write-heading-ids": "docusaurus write-heading-ids",
16
- "typecheck": "tsc"
17
- },
18
- "dependencies": {
19
- "@docusaurus/core": "^3.9.2",
20
- "@docusaurus/preset-classic": "^3.9.2",
21
- "@docusaurus/theme-mermaid": "^3.9.2",
22
- "@mdx-js/react": "^3.0.0",
23
- "@sp-days-framework/docusaurus-frontpage-collection": "^1.0.4",
24
- "@sp-days-framework/docusaurus-plugin-interactive-tasks": "^1.0.4",
25
- "@sp-days-framework/docusaurus-plugin-slidev": "^1.0.4",
26
- "@sp-days-framework/slidev-theme-sykehuspartner": "^1.0.4",
27
- "clsx": "^2.0.0",
28
- "docusaurus-plugin-sass": "^0.2.6",
29
- "prism-react-renderer": "^2.3.0",
30
- "react": "^19.0.0",
31
- "react-dom": "^19.0.0"
32
- },
33
- "devDependencies": {
34
- "@docusaurus/module-type-aliases": "^3.9.2",
35
- "@docusaurus/tsconfig": "^3.9.2",
36
- "@docusaurus/types": "^3.9.2",
37
- "typescript": "~5.6.2"
38
- },
39
- "browserslist": {
40
- "production": [
41
- ">0.5%",
42
- "not dead",
43
- "not op_mini all"
44
- ],
45
- "development": [
46
- "last 3 chrome version",
47
- "last 3 firefox version",
48
- "last 5 safari version"
49
- ]
50
- },
51
- "engines": {
52
- "node": ">=20.0"
53
- }
54
- }