@sp-days-framework/create-sp-days 1.0.4 → 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 +59 -11
- 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/sp-days-framework-create-sp-days-1.0.3.tgz +0 -0
- package/templates/addon-resources/resources/interactive-tasks/creating-tasks.mdx +0 -254
- 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 -273
- package/templates/addon-resources/resources/interactive-tasks/setup/index.mdx +0 -120
- 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,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
|
-
}
|