@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.
- package/README.md +14 -0
- package/bin/index.js +2 -0
- package/docs/advanced-config.mdx +412 -0
- package/docs/changelog.mdx +129 -0
- package/docs/index.mdx +206 -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 +87 -0
- package/templates/page-course/docusaurus.config.ts +103 -10
- package/templates/page-course/package.json +12 -2
- package/templates/page-course/sidebarSections.js +118 -0
- package/templates/page-course/src/css/sp-days-theme.scss +428 -211
- 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,140 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
sidebar_position: 3
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
import Tabs from "@theme/Tabs";
|
|
6
|
-
import TabItem from "@theme/TabItem";
|
|
7
|
-
|
|
8
|
-
# Progress Components
|
|
9
|
-
|
|
10
|
-
Display task completion progress using the `TaskProgression` and `TaskProgressionOverview` components.
|
|
11
|
-
|
|
12
|
-
## Basic Usage
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
<Tabs>
|
|
16
|
-
<TabItem value="single" label="Single Page" default>
|
|
17
|
-
Display progress for a specific document with a visual progress indicator.
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
```mdx
|
|
21
|
-
<TaskProgression path="./examples/basic-usage.mdx" />
|
|
22
|
-
```
|
|
23
|
-
<div className="preview">
|
|
24
|
-
<div className="container" style={{ width: '-webkit-fill-available'}}>
|
|
25
|
-
<TaskProgression path="./examples/basic-usage.mdx" />
|
|
26
|
-
</div>
|
|
27
|
-
</div>
|
|
28
|
-
</TabItem>
|
|
29
|
-
<TabItem value="current" label="Current Page">
|
|
30
|
-
Reference the current page using `.` as the path:
|
|
31
|
-
|
|
32
|
-
```mdx
|
|
33
|
-
<TaskProgression path="." />
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
<div className="preview">
|
|
37
|
-
<div className="container" style={{ width: '-webkit-fill-available'}}>
|
|
38
|
-
<TaskProgression path="." />
|
|
39
|
-
</div>
|
|
40
|
-
</div>
|
|
41
|
-
<br/>
|
|
42
|
-
|
|
43
|
-
:::note
|
|
44
|
-
If no tasks is found on the page the Task Progression will show a error.
|
|
45
|
-
:::
|
|
46
|
-
</TabItem>
|
|
47
|
-
<TabItem value="result" label="Overview">
|
|
48
|
-
Display progress across all documents in the docs plugin instance.
|
|
49
|
-
|
|
50
|
-
```mdx
|
|
51
|
-
<TaskProgressionOverview />
|
|
52
|
-
```
|
|
53
|
-
<div className="preview">
|
|
54
|
-
<div className="container" style={{ width: '-webkit-fill-available', paddingBottom: '1.5rem'}}>
|
|
55
|
-
<TaskProgressionOverview />
|
|
56
|
-
</div>
|
|
57
|
-
</div>
|
|
58
|
-
</TabItem>
|
|
59
|
-
</Tabs>
|
|
60
|
-
|
|
61
|
-
---
|
|
62
|
-
|
|
63
|
-
## Path Formats
|
|
64
|
-
|
|
65
|
-
The component supports multiple path formats:
|
|
66
|
-
|
|
67
|
-
```mdx
|
|
68
|
-
<!-- Current page -->
|
|
69
|
-
<TaskProgression path="." />
|
|
70
|
-
|
|
71
|
-
<!-- Absolute path -->
|
|
72
|
-
<TaskProgression path="/docs/tasks/creating-tasks" />
|
|
73
|
-
|
|
74
|
-
<!-- Relative to current page -->
|
|
75
|
-
<TaskProgression path="./sibling-page" />
|
|
76
|
-
<TaskProgression path="../parent-page" />
|
|
77
|
-
|
|
78
|
-
<!-- With file extension -->
|
|
79
|
-
<TaskProgression path="/docs/tasks/tasks-showcase.mdx" />
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
---
|
|
83
|
-
|
|
84
|
-
## Examples
|
|
85
|
-
|
|
86
|
-
### Learning Module Overview
|
|
87
|
-
|
|
88
|
-
Create an overview page showing progress across all modules:
|
|
89
|
-
|
|
90
|
-
```mdx
|
|
91
|
-
---
|
|
92
|
-
title: Course Overview
|
|
93
|
-
---
|
|
94
|
-
|
|
95
|
-
# Welcome to the Course
|
|
96
|
-
|
|
97
|
-
Track your progress across all modules:
|
|
98
|
-
|
|
99
|
-
<TaskProgressionOverview />
|
|
100
|
-
```
|
|
101
|
-
|
|
102
|
-
### Module Navigation
|
|
103
|
-
|
|
104
|
-
Link between related modules with progress indicators:
|
|
105
|
-
|
|
106
|
-
```mdx
|
|
107
|
-
## Prerequisites
|
|
108
|
-
|
|
109
|
-
Make sure you've completed the previous module:
|
|
110
|
-
|
|
111
|
-
<TaskProgression path="../module-01/index" />
|
|
112
|
-
|
|
113
|
-
## Current Module
|
|
114
|
-
|
|
115
|
-
Your progress in this module:
|
|
116
|
-
|
|
117
|
-
<TaskProgression path="." />
|
|
118
|
-
|
|
119
|
-
## Next Steps
|
|
120
|
-
|
|
121
|
-
Continue to the next module:
|
|
122
|
-
|
|
123
|
-
<TaskProgression path="../module-03/index" />
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
### Section Summary
|
|
127
|
-
|
|
128
|
-
Show progress for the current page at the top:
|
|
129
|
-
|
|
130
|
-
```mdx
|
|
131
|
-
# Introduction to React
|
|
132
|
-
|
|
133
|
-
<TaskProgression path="." />
|
|
134
|
-
|
|
135
|
-
Complete the tasks below to learn React fundamentals.
|
|
136
|
-
|
|
137
|
-
::::task[Setup React Project]
|
|
138
|
-
...
|
|
139
|
-
::::
|
|
140
|
-
```
|
|
@@ -1,106 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Slidev Integration
|
|
3
|
-
hide_title: true
|
|
4
|
-
sidebar_class_name: sidebar-logo-docusaurus
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
import { Iconify } from "@sp-days-framework/docusaurus-frontpage-collection";
|
|
8
|
-
|
|
9
|
-
<div align="center">
|
|
10
|
-
<div className="resourceLandingPage">
|
|
11
|
-
<Iconify icon="logos:docusaurus" width="105px"/>
|
|
12
|
-
<Iconify icon="mdi:plus-thick" width="50px" iconColors={{ light: "#000000", dark: "#ffffff" }} />
|
|
13
|
-
<Iconify icon="logos:slidev" width="95px"/>
|
|
14
|
-
</div>
|
|
15
|
-
<div align="center">
|
|
16
|
-
# Docusaurus Slidev Integration
|
|
17
|
-
</div>
|
|
18
|
-
<div align="center">
|
|
19
|
-
<p>
|
|
20
|
-
*Seamlessly integrate Slidev presentations into your Docusaurus site!*
|
|
21
|
-
</p>
|
|
22
|
-
<h4>
|
|
23
|
-
[Setup](./setup/index.mdx)
|
|
24
|
-
·
|
|
25
|
-
[NPM Package](https://www.npmjs.com/package/@sp-days-framework/docusaurus-plugin-slidev)
|
|
26
|
-
·
|
|
27
|
-
[Source Code](https://github.com/helse-sorost/sp-days-framework)
|
|
28
|
-
</h4>
|
|
29
|
-
</div>
|
|
30
|
-
</div>
|
|
31
|
-
|
|
32
|
-
---
|
|
33
|
-
|
|
34
|
-
## Features
|
|
35
|
-
|
|
36
|
-
- **Automatic Discovery** - Scans directories for Slidev markdown files and builds them automatically
|
|
37
|
-
- **Interactive Overview Page** - Auto-generated gallery with presentation previews, metadata, and sorting
|
|
38
|
-
- **Zero-Config Setup** - Works out of the box with sensible defaults
|
|
39
|
-
- **Theme Support** - Global or per-presentation theme configuration with automatic validation
|
|
40
|
-
- **Development & Production Modes** - Fast development workflow with separate slide preview
|
|
41
|
-
|
|
42
|
-
## Getting Started
|
|
43
|
-
|
|
44
|
-
### 1. Create Your Presentation
|
|
45
|
-
|
|
46
|
-
Create a presentation in the `/slidev/` directory:
|
|
47
|
-
|
|
48
|
-
```markdown title="slidev/introduction.md"
|
|
49
|
-
---
|
|
50
|
-
theme: "@sp-days-framework/slidev-theme-sykehuspartner"
|
|
51
|
-
title: Introduction to Docker
|
|
52
|
-
description: Learn containerization fundamentals
|
|
53
|
-
author: Your Name
|
|
54
|
-
layout: cover
|
|
55
|
-
---
|
|
56
|
-
|
|
57
|
-
# Introduction to Docker
|
|
58
|
-
## Containerization Made Simple
|
|
59
|
-
|
|
60
|
-
---
|
|
61
|
-
|
|
62
|
-
# What is Docker?
|
|
63
|
-
|
|
64
|
-
Docker is a platform for developing, shipping, and running applications in containers.
|
|
65
|
-
```
|
|
66
|
-
### 2. Live Preview During Development
|
|
67
|
-
|
|
68
|
-
Run Slidev directly to work on your presentation with hot-reload:
|
|
69
|
-
|
|
70
|
-
```bash
|
|
71
|
-
npm run slidev ./slidev/my-presentation.md
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
This opens your presentation in the browser with live updates as you edit.
|
|
75
|
-
|
|
76
|
-
### 3. View in Docusaurus
|
|
77
|
-
|
|
78
|
-
Build your Docusaurus site to see presentations integrated:
|
|
79
|
-
|
|
80
|
-
```bash
|
|
81
|
-
npm run build
|
|
82
|
-
npm run serve
|
|
83
|
-
```
|
|
84
|
-
|
|
85
|
-
Open the page and select "Slides" in the navbar to see the overview gallery.
|
|
86
|
-
|
|
87
|
-
:::note[Development Mode Limitation]
|
|
88
|
-
|
|
89
|
-
Presentations are **not built** during `npm run start`, [read more about it here.](./setup/index.mdx#development-vs-production-modes)
|
|
90
|
-
|
|
91
|
-
:::
|
|
92
|
-
|
|
93
|
-
See [Setup](./setup/index.mdx) for installation and configuration.
|
|
94
|
-
|
|
95
|
-
## How It Works
|
|
96
|
-
|
|
97
|
-
1. **Scan Phase** - Plugin scans the `/slidev/` directory for `.md` files during build
|
|
98
|
-
2. **Extract Metadata** - Frontmatter is parsed from each file (title, description, theme, author)
|
|
99
|
-
3. **Build Phase** - In production, Slidev builds each presentation to `static/slides/`
|
|
100
|
-
4. **Generate Overview** - Creates an interactive overview page (default: `/slidev`) with previews
|
|
101
|
-
5. **Serve** - Built presentations are accessible via unique URLs
|
|
102
|
-
|
|
103
|
-
## Documentation
|
|
104
|
-
|
|
105
|
-
- **[Advanced Configuration](./setup/advanced-configuration.mdx)** - Detailed plugin options
|
|
106
|
-
- **[Sykehuspartner Theme](../sykehuspartner-theme/index.mdx)** - Theme documentation and layouts
|
package/templates/addon-resources/resources/slidev-integration/setup/advanced-configuration.mdx
DELETED
|
@@ -1,144 +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
|
-
## All Plugin Options
|
|
12
|
-
|
|
13
|
-
| Option | Type | Default | Description |
|
|
14
|
-
| ----------------- | --------- | ------------------------------------- | ------------------------------------------------------------------ |
|
|
15
|
-
| `sourceDir` | `string` | `'./slidev'` | Directory to scan for Slidev markdown files |
|
|
16
|
-
| `outputDir` | `string` | `'slides'` | Output directory inside `static/` for built presentations |
|
|
17
|
-
| `theme` | `string` | `undefined` | Global theme override for all presentations |
|
|
18
|
-
| `download` | `boolean` | `false` | Enable PDF download functionality |
|
|
19
|
-
| `overviewPath` | `string` | `'/slidev'` | URL path for the auto-generated overview page |
|
|
20
|
-
| `overviewTitle` | `string` | `'Slidev Presentations'` | Custom title for the overview page |
|
|
21
|
-
| `overviewTagline` | `string` | `'Interactive presentation overview'` | Custom tagline/description for the overview page |
|
|
22
|
-
| `id` | `string` | `'default'` | Plugin ID for multiple instances |
|
|
23
|
-
| `buildTimeout` | `number` | `60` | Timeout in seconds for building each presentation (10-600) |
|
|
24
|
-
| `verbose` | `boolean` | `false` | Enable verbose logging for Slidev build output |
|
|
25
|
-
|
|
26
|
-
## All Frontmatter Options
|
|
27
|
-
|
|
28
|
-
Configure individual presentations using frontmatter:
|
|
29
|
-
|
|
30
|
-
| Option | Type | Description |
|
|
31
|
-
| ------------- | -------- | ---------------------------------------------- |
|
|
32
|
-
| `theme` | `string` | Theme to use (overrides plugin global theme) |
|
|
33
|
-
| `title` | `string` | Presentation title |
|
|
34
|
-
| `description` | `string` | Brief description for overview page |
|
|
35
|
-
| `author` | `string` | Author name(s) |
|
|
36
|
-
| `layout` | `string` | Layout for the slide (e.g., `cover`, `intro`) |
|
|
37
|
-
|
|
38
|
-
See [Slidev documentation](https://sli.dev/guide/syntax.html#frontmatter) for all available frontmatter options.
|
|
39
|
-
|
|
40
|
-
## Multiple Plugin Instances
|
|
41
|
-
|
|
42
|
-
Run multiple instances with different configurations:
|
|
43
|
-
|
|
44
|
-
```js title="docusaurus.config.js"
|
|
45
|
-
module.exports = {
|
|
46
|
-
staticDirectories: ["static"],
|
|
47
|
-
|
|
48
|
-
plugins: [
|
|
49
|
-
[
|
|
50
|
-
"@sp-days-framework/docusaurus-plugin-slidev",
|
|
51
|
-
{
|
|
52
|
-
id: "workshops",
|
|
53
|
-
sourceDir: "./slidev/workshops",
|
|
54
|
-
overviewPath: "/workshops/slides",
|
|
55
|
-
overviewTitle: "Workshop Presentations",
|
|
56
|
-
},
|
|
57
|
-
],
|
|
58
|
-
[
|
|
59
|
-
"@sp-days-framework/docusaurus-plugin-slidev",
|
|
60
|
-
{
|
|
61
|
-
id: "training",
|
|
62
|
-
sourceDir: "./slidev/training",
|
|
63
|
-
overviewPath: "/training/slides",
|
|
64
|
-
overviewTitle: "Training Materials",
|
|
65
|
-
},
|
|
66
|
-
],
|
|
67
|
-
],
|
|
68
|
-
};
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
This allows you to organize different types of presentations separately.
|
|
72
|
-
|
|
73
|
-
## Global Theme Configuration
|
|
74
|
-
|
|
75
|
-
Set a default theme for all presentations:
|
|
76
|
-
|
|
77
|
-
```js title="docusaurus.config.js"
|
|
78
|
-
module.exports = {
|
|
79
|
-
plugins: [
|
|
80
|
-
[
|
|
81
|
-
"@sp-days-framework/docusaurus-plugin-slidev",
|
|
82
|
-
{
|
|
83
|
-
theme: "@sp-days-framework/slidev-theme-sykehuspartner",
|
|
84
|
-
},
|
|
85
|
-
],
|
|
86
|
-
],
|
|
87
|
-
};
|
|
88
|
-
```
|
|
89
|
-
|
|
90
|
-
Individual presentations can override this by specifying a theme in their frontmatter.
|
|
91
|
-
|
|
92
|
-
## Custom Overview Page
|
|
93
|
-
|
|
94
|
-
Customize the presentation overview page appearance:
|
|
95
|
-
|
|
96
|
-
```js title="docusaurus.config.js"
|
|
97
|
-
module.exports = {
|
|
98
|
-
plugins: [
|
|
99
|
-
[
|
|
100
|
-
"@sp-days-framework/docusaurus-plugin-slidev",
|
|
101
|
-
{
|
|
102
|
-
overviewPath: "/presentations",
|
|
103
|
-
overviewTitle: "Our Presentations",
|
|
104
|
-
overviewTagline: "Explore our collection of learning materials",
|
|
105
|
-
},
|
|
106
|
-
],
|
|
107
|
-
],
|
|
108
|
-
};
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
## Build Timeout Configuration
|
|
112
|
-
|
|
113
|
-
For large presentations, increase the build timeout:
|
|
114
|
-
|
|
115
|
-
```js title="docusaurus.config.js"
|
|
116
|
-
module.exports = {
|
|
117
|
-
plugins: [
|
|
118
|
-
[
|
|
119
|
-
"@sp-days-framework/docusaurus-plugin-slidev",
|
|
120
|
-
{
|
|
121
|
-
buildTimeout: 120, // 2 minutes per presentation
|
|
122
|
-
verbose: true, // Enable verbose logging
|
|
123
|
-
},
|
|
124
|
-
],
|
|
125
|
-
],
|
|
126
|
-
};
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
## PDF Download Support
|
|
130
|
-
|
|
131
|
-
Enable PDF download functionality for presentations:
|
|
132
|
-
|
|
133
|
-
```js title="docusaurus.config.js"
|
|
134
|
-
module.exports = {
|
|
135
|
-
plugins: [
|
|
136
|
-
[
|
|
137
|
-
"@sp-days-framework/docusaurus-plugin-slidev",
|
|
138
|
-
{
|
|
139
|
-
download: true,
|
|
140
|
-
},
|
|
141
|
-
],
|
|
142
|
-
],
|
|
143
|
-
};
|
|
144
|
-
```
|
|
@@ -1,200 +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 Slidev Docusaurus Plugin is already installed and configured. You can start creating presentations right away!
|
|
12
|
-
:::
|
|
13
|
-
|
|
14
|
-
## Installation
|
|
15
|
-
|
|
16
|
-
Install the Docusaurus plugin using your preferred package manager:
|
|
17
|
-
|
|
18
|
-
<Tabs>
|
|
19
|
-
<TabItem value="npm" label="npm" default>
|
|
20
|
-
```bash
|
|
21
|
-
npm install @sp-days-framework/docusaurus-plugin-slidev
|
|
22
|
-
```
|
|
23
|
-
</TabItem>
|
|
24
|
-
<TabItem value="yarn" label="Yarn">
|
|
25
|
-
```bash
|
|
26
|
-
yarn add @sp-days-framework/docusaurus-plugin-slidev
|
|
27
|
-
```
|
|
28
|
-
</TabItem>
|
|
29
|
-
</Tabs>
|
|
30
|
-
|
|
31
|
-
Install Slidev dependencies:
|
|
32
|
-
|
|
33
|
-
<Tabs>
|
|
34
|
-
<TabItem value="sp-theme" label="Sykehuspartner Theme" default>
|
|
35
|
-
```bash
|
|
36
|
-
npm install @sp-days-framework/slidev-theme-sykehuspartner
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
Includes everything needed for Sykehuspartner branded presentations.
|
|
40
|
-
</TabItem>
|
|
41
|
-
<TabItem value="default" label="Default Theme">
|
|
42
|
-
```bash
|
|
43
|
-
npm install @slidev/theme-default
|
|
44
|
-
```
|
|
45
|
-
</TabItem>
|
|
46
|
-
</Tabs>
|
|
47
|
-
|
|
48
|
-
Add the plugin to your `docusaurus.config.js`:
|
|
49
|
-
|
|
50
|
-
```js title="docusaurus.config.js" {2,4}
|
|
51
|
-
module.exports = {
|
|
52
|
-
staticDirectories: ["static"],
|
|
53
|
-
|
|
54
|
-
plugins: ["@sp-days-framework/docusaurus-plugin-slidev"],
|
|
55
|
-
};
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
:::note
|
|
59
|
-
The `static` directory is required for serving built presentations.
|
|
60
|
-
:::
|
|
61
|
-
|
|
62
|
-
**Optional:** Add the `slidev` script for live preview during development:
|
|
63
|
-
|
|
64
|
-
```json title="package.json" {4}
|
|
65
|
-
{
|
|
66
|
-
"scripts": {
|
|
67
|
-
"docusaurus": "docusaurus",
|
|
68
|
-
"slidev": "slidev"
|
|
69
|
-
}
|
|
70
|
-
}
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
## Configuration
|
|
74
|
-
|
|
75
|
-
### Basic Plugin Setup
|
|
76
|
-
|
|
77
|
-
The plugin works with default settings:
|
|
78
|
-
|
|
79
|
-
```js title="docusaurus.config.js"
|
|
80
|
-
module.exports = {
|
|
81
|
-
staticDirectories: ["static"],
|
|
82
|
-
plugins: ["@sp-days-framework/docusaurus-plugin-slidev"],
|
|
83
|
-
};
|
|
84
|
-
```
|
|
85
|
-
|
|
86
|
-
### Plugin Options
|
|
87
|
-
|
|
88
|
-
Customize the plugin behavior:
|
|
89
|
-
|
|
90
|
-
```js title="docusaurus.config.js"
|
|
91
|
-
module.exports = {
|
|
92
|
-
plugins: [
|
|
93
|
-
[
|
|
94
|
-
"@sp-days-framework/docusaurus-plugin-slidev",
|
|
95
|
-
{
|
|
96
|
-
sourceDir: "./slidev",
|
|
97
|
-
outputDir: "slides",
|
|
98
|
-
theme: "@sp-days-framework/slidev-theme-sykehuspartner",
|
|
99
|
-
overviewPath: "/presentations",
|
|
100
|
-
},
|
|
101
|
-
],
|
|
102
|
-
],
|
|
103
|
-
};
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
Common options:
|
|
107
|
-
|
|
108
|
-
| Option | Type | Default | Description |
|
|
109
|
-
| ----------------- | --------- | ------------------------------------- | ------------------------------------------------------------------ |
|
|
110
|
-
| `sourceDir` | `string` | `'./slidev'` | Directory to scan for Slidev markdown files |
|
|
111
|
-
| `outputDir` | `string` | `'slides'` | Output directory inside `static/` for built presentations |
|
|
112
|
-
| `theme` | `string` | `undefined` | Global theme override for all presentations |
|
|
113
|
-
| `overviewPath` | `string` | `'/slidev'` | URL path for the auto-generated overview page |
|
|
114
|
-
| `overviewTitle` | `string` | `'Slidev Presentations'` | Title for the overview page |
|
|
115
|
-
|
|
116
|
-
See [Advanced Configuration](./advanced-configuration.mdx) for all options.
|
|
117
|
-
|
|
118
|
-
### Frontmatter Configuration
|
|
119
|
-
|
|
120
|
-
Configure individual presentations:
|
|
121
|
-
|
|
122
|
-
```markdown title="slidev/introduction.md"
|
|
123
|
-
---
|
|
124
|
-
theme: "@sp-days-framework/slidev-theme-sykehuspartner"
|
|
125
|
-
title: Introduction to Docker
|
|
126
|
-
description: Learn containerization fundamentals
|
|
127
|
-
author: Your Name
|
|
128
|
-
layout: cover
|
|
129
|
-
---
|
|
130
|
-
|
|
131
|
-
# Introduction to Docker
|
|
132
|
-
## Containerization Made Simple
|
|
133
|
-
```
|
|
134
|
-
|
|
135
|
-
Common frontmatter options:
|
|
136
|
-
|
|
137
|
-
| Option | Description |
|
|
138
|
-
| ------------- | ---------------------------------------------- |
|
|
139
|
-
| `theme` | Theme to use (overrides plugin global theme) |
|
|
140
|
-
| `title` | Presentation title |
|
|
141
|
-
| `description` | Brief description for overview page |
|
|
142
|
-
| `author` | Author name(s) |
|
|
143
|
-
| `layout` | Layout for the slide (e.g., `cover`, `intro`) |
|
|
144
|
-
|
|
145
|
-
## Development vs Production Modes
|
|
146
|
-
|
|
147
|
-
The plugin operates differently in development and production modes due to technical limitations:
|
|
148
|
-
|
|
149
|
-
**Why no live preview in development?**
|
|
150
|
-
- Slidev's CLI can only run one presentation at a time
|
|
151
|
-
- Building presentations takes 5-10+ seconds each
|
|
152
|
-
- Running builds during development would significantly slow down the dev server
|
|
153
|
-
|
|
154
|
-
This design choice prioritizes developer experience by keeping the documentation development workflow fast.
|
|
155
|
-
|
|
156
|
-
### Development Mode (`npm run start`)
|
|
157
|
-
|
|
158
|
-
- Presentations are **not built** automatically
|
|
159
|
-
- Overview page shows "Build Required" badges
|
|
160
|
-
- Much faster startup time
|
|
161
|
-
|
|
162
|
-
**Use for:** Active documentation development
|
|
163
|
-
|
|
164
|
-
### Production Mode (`npm run build`)
|
|
165
|
-
|
|
166
|
-
- All presentations are **automatically built**
|
|
167
|
-
- Overview page shows interactive preview thumbnails
|
|
168
|
-
- Presentations are fully functional
|
|
169
|
-
|
|
170
|
-
**Use for:** Deploying to production or testing integration
|
|
171
|
-
|
|
172
|
-
### Recommended Workflow
|
|
173
|
-
|
|
174
|
-
<Tabs>
|
|
175
|
-
<TabItem value="slides" label="Working on Slides" default>
|
|
176
|
-
```bash
|
|
177
|
-
# Live preview with hot-reload
|
|
178
|
-
npm run slidev ./slidev/your-presentation.md
|
|
179
|
-
```
|
|
180
|
-
|
|
181
|
-
Edit your presentation and see changes instantly.
|
|
182
|
-
</TabItem>
|
|
183
|
-
<TabItem value="verify" label="Verify Integration">
|
|
184
|
-
```bash
|
|
185
|
-
# Build and serve to see final result
|
|
186
|
-
npm run build
|
|
187
|
-
npm run serve
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
Navigate to `/slidev` to see the overview page.
|
|
191
|
-
</TabItem>
|
|
192
|
-
<TabItem value="docs" label="Working on Docs">
|
|
193
|
-
```bash
|
|
194
|
-
# Fast development server (slides not built)
|
|
195
|
-
npm run start
|
|
196
|
-
```
|
|
197
|
-
|
|
198
|
-
Focus on documentation without waiting for slide builds.
|
|
199
|
-
</TabItem>
|
|
200
|
-
</Tabs>
|
|
@@ -1,105 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Sykehuspartner Theme
|
|
3
|
-
sidebar_class_name: sidebar-logo-slidev
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
import useBaseUrl from '@docusaurus/useBaseUrl';
|
|
7
|
-
import ThemedImage from '@theme/ThemedImage';
|
|
8
|
-
import { Iconify } from "@sp-days-framework/docusaurus-frontpage-collection";
|
|
9
|
-
|
|
10
|
-
<div align="center">
|
|
11
|
-
<div className="resourceLandingPage">
|
|
12
|
-
<Iconify icon="logos:slidev" width="105px"/>
|
|
13
|
-
<Iconify icon="mdi:plus-thick" width="50px" iconColors={{ light: "#000000", dark: "#ffffff" }} />
|
|
14
|
-
<ThemedImage
|
|
15
|
-
style={{ width: '95px'}}
|
|
16
|
-
sources={{
|
|
17
|
-
light: useBaseUrl('/img/favicon-navbar/sorost-logo-light.svg'),
|
|
18
|
-
dark: useBaseUrl('/img/favicon-navbar/sorost-logo-dark.svg'),
|
|
19
|
-
}}
|
|
20
|
-
/>
|
|
21
|
-
</div>
|
|
22
|
-
<div align="center">
|
|
23
|
-
# Sykehuspartner Slidev Theme
|
|
24
|
-
</div>
|
|
25
|
-
<div align="center">
|
|
26
|
-
<p>
|
|
27
|
-
*Create professional presentations using Sykehuspartner theme for Slidev!*
|
|
28
|
-
</p>
|
|
29
|
-
<h4>
|
|
30
|
-
[Setup](./setup/index.mdx)
|
|
31
|
-
·
|
|
32
|
-
[NPM Package](https://www.npmjs.com/package/@sp-days-framework/slidev-theme-sykehuspartner)
|
|
33
|
-
·
|
|
34
|
-
[Source Code](https://github.com/helse-sorost/sp-days-framework)
|
|
35
|
-
</h4>
|
|
36
|
-
</div>
|
|
37
|
-
</div>
|
|
38
|
-
|
|
39
|
-
---
|
|
40
|
-
|
|
41
|
-
## Features
|
|
42
|
-
|
|
43
|
-
- **18 Professional Layouts** - From cover slides to multi-column content, image layouts, and special-purpose slides
|
|
44
|
-
- **Consistent Branding** - Sykehuspartner colors, logos, and styling throughout
|
|
45
|
-
- **Dark Mode Support** - Automatic light/dark theme switching with optimized colors
|
|
46
|
-
- **Syntax Highlighting** - Support for 30+ programming languages powered by Shiki
|
|
47
|
-
- **VSCode Icons** - Built-in icon support for technical content with automatic scanning
|
|
48
|
-
- **Responsive Design** - Looks great on any screen size
|
|
49
|
-
|
|
50
|
-
## Getting Started
|
|
51
|
-
|
|
52
|
-
Configure the theme and start creating slides:
|
|
53
|
-
|
|
54
|
-
```markdown title="slidev/presentation.md"
|
|
55
|
-
---
|
|
56
|
-
theme: "@sp-days-framework/slidev-theme-sykehuspartner"
|
|
57
|
-
title: My Presentation
|
|
58
|
-
layout: cover
|
|
59
|
-
---
|
|
60
|
-
|
|
61
|
-
# My Presentation Title
|
|
62
|
-
## Subtitle Goes Here
|
|
63
|
-
|
|
64
|
-
---
|
|
65
|
-
layout: default
|
|
66
|
-
---
|
|
67
|
-
|
|
68
|
-
# First Content Slide
|
|
69
|
-
|
|
70
|
-
- Point 1
|
|
71
|
-
- Point 2
|
|
72
|
-
- Point 3
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
See [Setup](./setup/index.mdx) for installation and configuration.
|
|
76
|
-
|
|
77
|
-
## Available Layouts
|
|
78
|
-
|
|
79
|
-
The theme includes 18 specialized layouts for different presentation needs:
|
|
80
|
-
|
|
81
|
-
| Layout | Use Case | Category |
|
|
82
|
-
|--------|----------|----------|
|
|
83
|
-
| [cover](./layouts/section/cover.mdx) | Title slide with banner | Section |
|
|
84
|
-
| [intro](./layouts/section/intro.mdx) | Introduction with optional side image | Section |
|
|
85
|
-
| [section](./layouts/section/section.mdx) | Section divider with optional image | Section |
|
|
86
|
-
| [end](./layouts/section/end.mdx) | Closing slide with centered banner | Section |
|
|
87
|
-
| [default](./layouts/content/default.mdx) | Standard content with header extraction | Content |
|
|
88
|
-
| [center](./layouts/content/center.mdx) | Vertically centered content | Content |
|
|
89
|
-
| [full](./layouts/content/full.mdx) | Full-screen with no padding | Content |
|
|
90
|
-
| [two-cols](./layouts/multi-column/two-cols.mdx) | Two equal columns | Multi-Column |
|
|
91
|
-
| [two-cols-header](./layouts/multi-column/two-cols-header.mdx) | Two columns with header | Multi-Column |
|
|
92
|
-
| [three-cols](./layouts/multi-column/three-cols.mdx) | Three equal columns | Multi-Column |
|
|
93
|
-
| [three-cols-header](./layouts/multi-column/three-cols-header.mdx) | Three columns with header | Multi-Column |
|
|
94
|
-
| [image](./layouts/image/image.mdx) | Background or foreground image | Image |
|
|
95
|
-
| [image-left](./layouts/image/image-left.mdx) | Content with left-aligned image | Image |
|
|
96
|
-
| [image-right](./layouts/image/image-right.mdx) | Content with right-aligned image | Image |
|
|
97
|
-
| [fact](./layouts/special/fact.mdx) | Emphasize key facts | Special |
|
|
98
|
-
| [statement](./layouts/special/statement.mdx) | Bold statement slide | Special |
|
|
99
|
-
| [quote](./layouts/special/quote.mdx) | Quote with attribution | Special |
|
|
100
|
-
| [about-me](./layouts/special/about-me.mdx) | Profile introduction | Special |
|
|
101
|
-
|
|
102
|
-
## Documentation
|
|
103
|
-
|
|
104
|
-
- **[Syntax Highlighting & Icons](./syntax-and-icons.mdx)** - Code highlighting and icon usage
|
|
105
|
-
- **[Advanced Configuration](./setup/advanced-configuration.mdx)** - Layout parameters and customization
|