@sp-days-framework/create-sp-days 1.1.0-beta1 → 1.1.0-beta3
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/docs/advanced-config.mdx +37 -12
- package/docs/changelog.mdx +38 -0
- package/docs/index.mdx +2 -1
- package/lib/.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/publish-package-docs.js +8 -0
- package/templates/addon-resources/resources/index.mdx +1 -1
- package/templates/addon-slidev/slidev/best-practices-guide.md +769 -0
- package/templates/addon-slidev/slidev/slidev-theme-sykehuspartner.md +1 -1
- package/templates/addon-slidev/slidev/templates/_category_.yml +2 -0
- package/templates/addon-slidev/slidev/templates/process-documentation.md +193 -0
- package/templates/addon-slidev/slidev/templates/technical-workshop.md +160 -0
- package/templates/addon-slidev/slidev/templates/tool-introduction.md +160 -0
- package/templates/addon-slidev/slidev/templates/training-module.md +149 -0
- package/templates/page-course/README.md +37 -12
- package/templates/page-course/course/placeholder-basic-usage.mdx +40 -6
- package/templates/page-course/docusaurus.config.ts +93 -43
- package/templates/page-course/package.json +6 -5
- package/templates/page-course/src/css/sp-days-theme.scss +428 -211
|
@@ -11,18 +11,52 @@ See interactive tasks in action with real-world examples. This page demonstrates
|
|
|
11
11
|
|
|
12
12
|
---
|
|
13
13
|
|
|
14
|
-
::::task[Install the
|
|
14
|
+
::::task[Install the SP Days Package]
|
|
15
15
|
|
|
16
|
-
Follow these steps to
|
|
16
|
+
Follow these steps to create a SP Days instance in your repo:
|
|
17
17
|
|
|
18
18
|
1. Open your terminal in the project root directory
|
|
19
|
-
2. Run the installation
|
|
20
|
-
3. Verify the package appears in your `package.json` dependencies
|
|
21
|
-
|
|
19
|
+
2. Run the installation `npx @sp-days-framework/create-sp-day`
|
|
22
20
|
|
|
23
21
|
:::hint
|
|
24
22
|
|
|
25
|
-
|
|
23
|
+
All packages and plugins will be installed and pre-configured!
|
|
24
|
+
|
|
25
|
+
:::
|
|
26
|
+
|
|
27
|
+
:::output
|
|
28
|
+
|
|
29
|
+
```terminal user="ubuntu" host="server" directory="~/"
|
|
30
|
+
// command "npx @sp-days-framework/create-sp-days"
|
|
31
|
+
{cyan}[INFO]{/cyan} Creating a new SP-Days site...
|
|
32
|
+
{green}[SUCCESS]{/green} Base template copied
|
|
33
|
+
{green}[SUCCESS]{/green} Slidev addon installed
|
|
34
|
+
{green}[SUCCESS]{/green} Resources addon installed
|
|
35
|
+
{green}[SUCCESS]{/green} Configuration processed
|
|
36
|
+
{cyan}[INFO]{/cyan} Installing dependencies with npm...
|
|
37
|
+
{green}[SUCCESS]{/green} Dependencies installed
|
|
38
|
+
{green}[SUCCESS]{/green} Created example-repo at "docs".
|
|
39
|
+
{cyan}[INFO]{/cyan} Inside that directory, you can run several commands:
|
|
40
|
+
|
|
41
|
+
{cyan}`npm start`{/cyan}
|
|
42
|
+
Starts the development server.
|
|
43
|
+
|
|
44
|
+
{cyan}`npm run build`{/cyan}
|
|
45
|
+
Bundles your website into static files for production.
|
|
46
|
+
|
|
47
|
+
{cyan}`npm run serve`{/cyan}
|
|
48
|
+
Serves the built website locally.
|
|
49
|
+
|
|
50
|
+
{cyan}`npm run slidev`{/cyan}
|
|
51
|
+
Launches Slidev presentation server.
|
|
52
|
+
|
|
53
|
+
We suggest that you begin by typing:
|
|
54
|
+
|
|
55
|
+
{cyan}`cd docs`{/cyan}
|
|
56
|
+
{cyan}`npm start`{/cyan}
|
|
57
|
+
|
|
58
|
+
Happy days! 📚
|
|
59
|
+
```
|
|
26
60
|
|
|
27
61
|
:::
|
|
28
62
|
|
|
@@ -37,16 +37,7 @@ const config: Config = {
|
|
|
37
37
|
[
|
|
38
38
|
"classic",
|
|
39
39
|
{
|
|
40
|
-
docs:
|
|
41
|
-
id: "course",
|
|
42
|
-
path: "course",
|
|
43
|
-
routeBasePath: "course",
|
|
44
|
-
sidebarItemsGenerator: require('./sidebarSections'),
|
|
45
|
-
beforeDefaultRemarkPlugins: [
|
|
46
|
-
require("@sp-days-framework/docusaurus-plugin-interactive-tasks")
|
|
47
|
-
.remarkTaskDirective,
|
|
48
|
-
],
|
|
49
|
-
},
|
|
40
|
+
docs: false, // Disable default docs plugin, using separate instances instead
|
|
50
41
|
theme: {
|
|
51
42
|
customCss: "./src/css/sp-days-theme.scss",
|
|
52
43
|
},
|
|
@@ -61,66 +52,100 @@ const config: Config = {
|
|
|
61
52
|
// Adds the Interactive Tasks plugin to enable task directives
|
|
62
53
|
"@sp-days-framework/docusaurus-plugin-interactive-tasks",
|
|
63
54
|
|
|
64
|
-
//
|
|
65
|
-
|
|
55
|
+
// Adds the Terminal Codeblock plugin to enable terminal output rendering
|
|
56
|
+
"@sp-days-framework/docusaurus-plugin-terminal-codeblock",
|
|
57
|
+
|
|
58
|
+
// Course documentation instance (main content)
|
|
66
59
|
[
|
|
67
60
|
"@docusaurus/plugin-content-docs",
|
|
68
61
|
{
|
|
69
|
-
|
|
70
|
-
|
|
62
|
+
id: "course",
|
|
63
|
+
path: "course",
|
|
64
|
+
routeBasePath: "course",
|
|
65
|
+
sidebarItemsGenerator: require("./sidebarSections"),
|
|
66
|
+
remarkPlugins: [
|
|
67
|
+
require("@sp-days-framework/docusaurus-plugin-terminal-codeblock")
|
|
68
|
+
.remarkTerminalDirective,
|
|
69
|
+
],
|
|
70
|
+
beforeDefaultRemarkPlugins: [
|
|
71
|
+
require("@sp-days-framework/docusaurus-plugin-interactive-tasks")
|
|
72
|
+
.remarkTaskDirective,
|
|
73
|
+
],
|
|
71
74
|
},
|
|
72
75
|
],
|
|
73
|
-
|
|
76
|
+
|
|
77
|
+
// CONDITIONAL: addon-resources (START)
|
|
78
|
+
// Resources documentation instance
|
|
74
79
|
[
|
|
75
80
|
"@docusaurus/plugin-content-docs",
|
|
76
81
|
{
|
|
77
|
-
|
|
78
|
-
|
|
82
|
+
id: "resources",
|
|
83
|
+
path: "resources",
|
|
84
|
+
routeBasePath: "resources",
|
|
85
|
+
sidebarItemsGenerator: require("./sidebarSections"),
|
|
86
|
+
remarkPlugins: [
|
|
87
|
+
require("@sp-days-framework/docusaurus-plugin-terminal-codeblock")
|
|
88
|
+
.remarkTerminalDirective,
|
|
89
|
+
],
|
|
90
|
+
},
|
|
91
|
+
],
|
|
92
|
+
// CONDITIONAL: addon-resources (END)
|
|
93
|
+
|
|
94
|
+
// CONDITIONAL: addon-slidev (START)
|
|
95
|
+
// Adds the Slidev plugin to enable slide presentations
|
|
96
|
+
"@sp-days-framework/docusaurus-plugin-slidev",
|
|
97
|
+
// CONDITIONAL: addon-slidev (END)
|
|
98
|
+
|
|
99
|
+
// CONDITIONAL: package-docs (START)
|
|
100
|
+
// Create SP Days Documentation
|
|
101
|
+
[
|
|
102
|
+
"@docusaurus/plugin-content-docs",
|
|
103
|
+
{
|
|
104
|
+
sidebarItemsGenerator: require("./sidebarSections"),
|
|
105
|
+
...require("@sp-days-framework/create-sp-days/publish-package-docs"),
|
|
79
106
|
},
|
|
80
107
|
],
|
|
81
108
|
// Frontpage Collection Documentation
|
|
82
109
|
[
|
|
83
110
|
"@docusaurus/plugin-content-docs",
|
|
84
111
|
{
|
|
85
|
-
sidebarItemsGenerator: require(
|
|
112
|
+
sidebarItemsGenerator: require("./sidebarSections"),
|
|
86
113
|
...require("@sp-days-framework/docusaurus-frontpage-collection/publish-package-docs"),
|
|
87
114
|
},
|
|
88
115
|
],
|
|
89
|
-
//
|
|
116
|
+
// Interactive Tasks Plugin Documentation
|
|
90
117
|
[
|
|
91
118
|
"@docusaurus/plugin-content-docs",
|
|
92
119
|
{
|
|
93
|
-
sidebarItemsGenerator: require(
|
|
94
|
-
...require("@sp-days-framework/
|
|
120
|
+
sidebarItemsGenerator: require("./sidebarSections"),
|
|
121
|
+
...require("@sp-days-framework/docusaurus-plugin-interactive-tasks/publish-package-docs"),
|
|
95
122
|
},
|
|
96
123
|
],
|
|
97
|
-
//
|
|
124
|
+
// Slidev Plugin Documentation
|
|
98
125
|
[
|
|
99
126
|
"@docusaurus/plugin-content-docs",
|
|
100
127
|
{
|
|
101
|
-
sidebarItemsGenerator: require(
|
|
102
|
-
...require("@sp-days-framework/
|
|
128
|
+
sidebarItemsGenerator: require("./sidebarSections"),
|
|
129
|
+
...require("@sp-days-framework/docusaurus-plugin-slidev/publish-package-docs"),
|
|
103
130
|
},
|
|
104
131
|
],
|
|
105
|
-
//
|
|
106
|
-
|
|
107
|
-
// CONDITIONAL: addon-slidev (START)
|
|
108
|
-
// Adds the Slidev plugin to enable slide presentations and static directories for Slidev assets
|
|
109
|
-
"@sp-days-framework/docusaurus-plugin-slidev",
|
|
110
|
-
// CONDITIONAL: addon-slidev (END)
|
|
111
|
-
|
|
112
|
-
// CONDITIONAL: addon-resources (START)
|
|
113
|
-
// Resources documentation instance
|
|
132
|
+
// Terminal Codeblock Plugin Documentation
|
|
114
133
|
[
|
|
115
134
|
"@docusaurus/plugin-content-docs",
|
|
116
135
|
{
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
routeBasePath: "resources",
|
|
120
|
-
sidebarItemsGenerator: require('./sidebarSections'),
|
|
136
|
+
sidebarItemsGenerator: require("./sidebarSections"),
|
|
137
|
+
...require("@sp-days-framework/docusaurus-plugin-terminal-codeblock/publish-package-docs"),
|
|
121
138
|
},
|
|
122
139
|
],
|
|
123
|
-
//
|
|
140
|
+
// Sykehuspartner Slidev Theme Documentation
|
|
141
|
+
[
|
|
142
|
+
"@docusaurus/plugin-content-docs",
|
|
143
|
+
{
|
|
144
|
+
sidebarItemsGenerator: require("./sidebarSections"),
|
|
145
|
+
...require("@sp-days-framework/slidev-theme-sykehuspartner/publish-package-docs"),
|
|
146
|
+
},
|
|
147
|
+
],
|
|
148
|
+
// CONDITIONAL: package-docs (END)
|
|
124
149
|
],
|
|
125
150
|
|
|
126
151
|
markdown: {
|
|
@@ -160,11 +185,36 @@ const config: Config = {
|
|
|
160
185
|
label: "Plugin Docs",
|
|
161
186
|
position: "left",
|
|
162
187
|
items: [
|
|
163
|
-
{
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
188
|
+
{
|
|
189
|
+
to: "/package-docs/create-sp-days",
|
|
190
|
+
label: "Create SP Days",
|
|
191
|
+
className: "title-logo-navbar-sp-days-plugin",
|
|
192
|
+
},
|
|
193
|
+
{
|
|
194
|
+
to: "/package-docs/frontpage-collection",
|
|
195
|
+
label: "Frontpage Collection",
|
|
196
|
+
className: "title-logo-navbar-docusaurus",
|
|
197
|
+
},
|
|
198
|
+
{
|
|
199
|
+
to: "/package-docs/interactive-tasks",
|
|
200
|
+
label: "Interactive Tasks",
|
|
201
|
+
className: "title-logo-navbar-docusaurus",
|
|
202
|
+
},
|
|
203
|
+
{
|
|
204
|
+
to: "/package-docs/slidev-integration",
|
|
205
|
+
label: "Slidev Integration",
|
|
206
|
+
className: "title-logo-navbar-docusaurus",
|
|
207
|
+
},
|
|
208
|
+
{
|
|
209
|
+
to: "/package-docs/terminal-codeblock",
|
|
210
|
+
label: "Terminal Codeblock",
|
|
211
|
+
className: "title-logo-navbar-docusaurus",
|
|
212
|
+
},
|
|
213
|
+
{
|
|
214
|
+
to: "/package-docs/sykehuspartner-theme",
|
|
215
|
+
label: "Sykehuspartner Theme",
|
|
216
|
+
className: "title-logo-navbar-slidev",
|
|
217
|
+
},
|
|
168
218
|
],
|
|
169
219
|
},
|
|
170
220
|
// CONDITIONAL: package-docs (END)
|
|
@@ -22,14 +22,15 @@
|
|
|
22
22
|
"@docusaurus/preset-classic": "^3.9.2",
|
|
23
23
|
"@docusaurus/theme-mermaid": "^3.9.2",
|
|
24
24
|
"@mdx-js/react": "^3.0.0",
|
|
25
|
-
"@sp-days-framework/docusaurus-frontpage-collection": "^1.1.0-
|
|
26
|
-
"@sp-days-framework/docusaurus-plugin-interactive-tasks": "^1.1.0-
|
|
25
|
+
"@sp-days-framework/docusaurus-frontpage-collection": "^1.1.0-beta3",
|
|
26
|
+
"@sp-days-framework/docusaurus-plugin-interactive-tasks": "^1.1.0-beta3",
|
|
27
|
+
"@sp-days-framework/docusaurus-plugin-terminal-codeblock": "^1.1.0-beta3",
|
|
27
28
|
// CONDITIONAL: addon-slidev (START)
|
|
28
|
-
"@sp-days-framework/docusaurus-plugin-slidev": "^1.1.0-
|
|
29
|
-
"@sp-days-framework/slidev-theme-sykehuspartner": "^1.1.0-
|
|
29
|
+
"@sp-days-framework/docusaurus-plugin-slidev": "^1.1.0-beta3",
|
|
30
|
+
"@sp-days-framework/slidev-theme-sykehuspartner": "^1.1.0-beta3",
|
|
30
31
|
// CONDITIONAL: addon-slidev (END)
|
|
31
32
|
// CONDITIONAL: package-docs (START)
|
|
32
|
-
"@sp-days-framework/create-sp-days": "^1.1.0-
|
|
33
|
+
"@sp-days-framework/create-sp-days": "^1.1.0-beta3",
|
|
33
34
|
// CONDITIONAL: package-docs (END)
|
|
34
35
|
"clsx": "^2.0.0",
|
|
35
36
|
"docusaurus-plugin-sass": "^0.2.6",
|