@sp-days-framework/docusaurus-plugin-slidev 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/docs/advanced-configuration.mdx +146 -0
- package/docs/changelog.mdx +72 -0
- package/docs/index.mdx +99 -0
- package/docs/install.mdx +201 -0
- package/docs/logo-docusaurus.svg +17 -0
- package/package.json +6 -3
- package/publish-package-docs.js +12 -0
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
---
|
|
2
|
+
sidebar_position: 1.2
|
|
3
|
+
sidebar_custom_props:
|
|
4
|
+
section: "Setup"
|
|
5
|
+
section_position: 1
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
import Tabs from "@theme/Tabs";
|
|
9
|
+
import TabItem from "@theme/TabItem";
|
|
10
|
+
|
|
11
|
+
# Advanced Configuration
|
|
12
|
+
|
|
13
|
+
## All Plugin Options
|
|
14
|
+
|
|
15
|
+
| Option | Type | Default | Description |
|
|
16
|
+
| ----------------- | --------- | ------------------------------------- | ------------------------------------------------------------------ |
|
|
17
|
+
| `sourceDir` | `string` | `'./slidev'` | Directory to scan for Slidev markdown files |
|
|
18
|
+
| `outputDir` | `string` | `'slides'` | Output directory inside `static/` for built presentations |
|
|
19
|
+
| `theme` | `string` | `undefined` | Global theme override for all presentations |
|
|
20
|
+
| `download` | `boolean` | `false` | Enable PDF download functionality |
|
|
21
|
+
| `overviewPath` | `string` | `'/slidev'` | URL path for the auto-generated overview page |
|
|
22
|
+
| `overviewTitle` | `string` | `'Slidev Presentations'` | Custom title for the overview page |
|
|
23
|
+
| `overviewTagline` | `string` | `'Interactive presentation overview'` | Custom tagline/description for the overview page |
|
|
24
|
+
| `id` | `string` | `'default'` | Plugin ID for multiple instances |
|
|
25
|
+
| `buildTimeout` | `number` | `60` | Timeout in seconds for building each presentation (10-600) |
|
|
26
|
+
| `verbose` | `boolean` | `false` | Enable verbose logging for Slidev build output |
|
|
27
|
+
|
|
28
|
+
## All Frontmatter Options
|
|
29
|
+
|
|
30
|
+
Configure individual presentations using frontmatter:
|
|
31
|
+
|
|
32
|
+
| Option | Type | Description |
|
|
33
|
+
| ------------- | -------- | ---------------------------------------------- |
|
|
34
|
+
| `theme` | `string` | Theme to use (overrides plugin global theme) |
|
|
35
|
+
| `title` | `string` | Presentation title |
|
|
36
|
+
| `description` | `string` | Brief description for overview page |
|
|
37
|
+
| `author` | `string` | Author name(s) |
|
|
38
|
+
| `layout` | `string` | Layout for the slide (e.g., `cover`, `intro`) |
|
|
39
|
+
|
|
40
|
+
See [Slidev documentation](https://sli.dev/guide/syntax.html#frontmatter) for all available frontmatter options.
|
|
41
|
+
|
|
42
|
+
## Multiple Plugin Instances
|
|
43
|
+
|
|
44
|
+
Run multiple instances with different configurations:
|
|
45
|
+
|
|
46
|
+
```js title="docusaurus.config.js"
|
|
47
|
+
module.exports = {
|
|
48
|
+
staticDirectories: ["static"],
|
|
49
|
+
|
|
50
|
+
plugins: [
|
|
51
|
+
[
|
|
52
|
+
"@sp-days-framework/docusaurus-plugin-slidev",
|
|
53
|
+
{
|
|
54
|
+
id: "workshops",
|
|
55
|
+
sourceDir: "./slidev/workshops",
|
|
56
|
+
overviewPath: "/workshops/slides",
|
|
57
|
+
overviewTitle: "Workshop Presentations",
|
|
58
|
+
},
|
|
59
|
+
],
|
|
60
|
+
[
|
|
61
|
+
"@sp-days-framework/docusaurus-plugin-slidev",
|
|
62
|
+
{
|
|
63
|
+
id: "training",
|
|
64
|
+
sourceDir: "./slidev/training",
|
|
65
|
+
overviewPath: "/training/slides",
|
|
66
|
+
overviewTitle: "Training Materials",
|
|
67
|
+
},
|
|
68
|
+
],
|
|
69
|
+
],
|
|
70
|
+
};
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
This allows you to organize different types of presentations separately.
|
|
74
|
+
|
|
75
|
+
## Global Theme Configuration
|
|
76
|
+
|
|
77
|
+
Set a default theme for all presentations:
|
|
78
|
+
|
|
79
|
+
```js title="docusaurus.config.js"
|
|
80
|
+
module.exports = {
|
|
81
|
+
plugins: [
|
|
82
|
+
[
|
|
83
|
+
"@sp-days-framework/docusaurus-plugin-slidev",
|
|
84
|
+
{
|
|
85
|
+
theme: "@sp-days-framework/slidev-theme-sykehuspartner",
|
|
86
|
+
},
|
|
87
|
+
],
|
|
88
|
+
],
|
|
89
|
+
};
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Individual presentations can override this by specifying a theme in their frontmatter.
|
|
93
|
+
|
|
94
|
+
## Custom Overview Page
|
|
95
|
+
|
|
96
|
+
Customize the presentation overview page appearance:
|
|
97
|
+
|
|
98
|
+
```js title="docusaurus.config.js"
|
|
99
|
+
module.exports = {
|
|
100
|
+
plugins: [
|
|
101
|
+
[
|
|
102
|
+
"@sp-days-framework/docusaurus-plugin-slidev",
|
|
103
|
+
{
|
|
104
|
+
overviewPath: "/presentations",
|
|
105
|
+
overviewTitle: "Our Presentations",
|
|
106
|
+
overviewTagline: "Explore our collection of learning materials",
|
|
107
|
+
},
|
|
108
|
+
],
|
|
109
|
+
],
|
|
110
|
+
};
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
## Build Timeout Configuration
|
|
114
|
+
|
|
115
|
+
For large presentations, increase the build timeout:
|
|
116
|
+
|
|
117
|
+
```js title="docusaurus.config.js"
|
|
118
|
+
module.exports = {
|
|
119
|
+
plugins: [
|
|
120
|
+
[
|
|
121
|
+
"@sp-days-framework/docusaurus-plugin-slidev",
|
|
122
|
+
{
|
|
123
|
+
buildTimeout: 120, // 2 minutes per presentation
|
|
124
|
+
verbose: true, // Enable verbose logging
|
|
125
|
+
},
|
|
126
|
+
],
|
|
127
|
+
],
|
|
128
|
+
};
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
## PDF Download Support
|
|
132
|
+
|
|
133
|
+
Enable PDF download functionality for presentations:
|
|
134
|
+
|
|
135
|
+
```js title="docusaurus.config.js"
|
|
136
|
+
module.exports = {
|
|
137
|
+
plugins: [
|
|
138
|
+
[
|
|
139
|
+
"@sp-days-framework/docusaurus-plugin-slidev",
|
|
140
|
+
{
|
|
141
|
+
download: true,
|
|
142
|
+
},
|
|
143
|
+
],
|
|
144
|
+
],
|
|
145
|
+
};
|
|
146
|
+
```
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
---
|
|
2
|
+
toc_max_heading_level: 2
|
|
3
|
+
sidebar_position: 3
|
|
4
|
+
sidebar_label: "Change Logs"
|
|
5
|
+
sidebar_custom_props:
|
|
6
|
+
section: "Releases"
|
|
7
|
+
section_position: 3
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Changelog
|
|
11
|
+
|
|
12
|
+
## `@sp-days-framework/docusaurus-plugin-slidev`
|
|
13
|
+
|
|
14
|
+
[](https://www.npmjs.com/package/@sp-days-framework/docusaurus-plugin-slidev)
|
|
15
|
+
|
|
16
|
+
:::note
|
|
17
|
+
All packages within `@sp-days-framework` use the same version number. In some cases, a package might just be "bumped" to match the rest without any functional changes.
|
|
18
|
+
:::
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## Version 1.1.0-beta2 
|
|
23
|
+
|
|
24
|
+
Documentation improvements and visual refinements
|
|
25
|
+
|
|
26
|
+
<details>
|
|
27
|
+
<summary><strong>Beta Details</strong> (2025 December 09)</summary>
|
|
28
|
+
|
|
29
|
+
### Improvements
|
|
30
|
+
|
|
31
|
+
- **Visual Consistency**: Improved sidebar and navbar logo handling for better branding support
|
|
32
|
+
|
|
33
|
+
</details>
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## Version 1.1.0-beta1 
|
|
38
|
+
|
|
39
|
+
Version bump to match other packages in the framework. Documentation is now bundled with the npm package for easier reference during development.
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## Version 1.0.4 
|
|
44
|
+
|
|
45
|
+
Version bump to match other packages in the framework
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
## Version 1.0.3 
|
|
50
|
+
|
|
51
|
+
Version bump to match other packages in the framework
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## Version 1.0.2 
|
|
56
|
+
|
|
57
|
+
Version bump to match other packages in the framework
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## Version 1.0.0 
|
|
62
|
+
|
|
63
|
+
Initial release of the Slidev Integration plugin
|
|
64
|
+
|
|
65
|
+
<details>
|
|
66
|
+
<summary><strong>Details</strong> (2025 November 24)</summary>
|
|
67
|
+
|
|
68
|
+
### New Features
|
|
69
|
+
|
|
70
|
+
- Initial release with Slidev integration functionality
|
|
71
|
+
|
|
72
|
+
</details>
|
package/docs/index.mdx
ADDED
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Slidev Integration
|
|
3
|
+
hide_title: true
|
|
4
|
+
sidebar_class_name: title-logo-sidebar-docusaurus
|
|
5
|
+
sidebar_label: "Slidev Integration"
|
|
6
|
+
sidebar_position: 0
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
import LogoDocusaurus from './logo-docusaurus.svg';
|
|
10
|
+
|
|
11
|
+
<div align="center">
|
|
12
|
+
<div style={{ display: 'flex', justifyContent: 'center', margin: '1rem' }}>
|
|
13
|
+
<LogoDocusaurus width="110" height="110"/>
|
|
14
|
+
</div>
|
|
15
|
+
<div align="center">
|
|
16
|
+
# Slidev Integration
|
|
17
|
+
</div>
|
|
18
|
+
<div align="center">
|
|
19
|
+
<p>
|
|
20
|
+
*Seamlessly integrate Slidev presentations into your Docusaurus site!*
|
|
21
|
+
</p>
|
|
22
|
+
<h4>
|
|
23
|
+
<a href="./slidev-integration/install">🔧 Setup</a> ·
|
|
24
|
+
<a href="https://www.npmjs.com/package/@sp-days-framework/docusaurus-plugin-slidev">📦 NPM Package</a> ·
|
|
25
|
+
<a href="https://github.com/helse-sorost/sp-days-framework">💻 Source Code</a>
|
|
26
|
+
</h4>
|
|
27
|
+
</div>
|
|
28
|
+
</div>
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## Features
|
|
33
|
+
|
|
34
|
+
- **Automatic Discovery** - Scans directories for Slidev markdown files and builds them automatically
|
|
35
|
+
- **Interactive Overview Page** - Auto-generated gallery with presentation previews, metadata, and sorting
|
|
36
|
+
- **Zero-Config Setup** - Works out of the box with sensible defaults
|
|
37
|
+
- **Theme Support** - Global or per-presentation theme configuration with automatic validation
|
|
38
|
+
- **Development & Production Modes** - Fast development workflow with separate slide preview
|
|
39
|
+
|
|
40
|
+
## Getting Started
|
|
41
|
+
|
|
42
|
+
### 1. Create Your Presentation
|
|
43
|
+
|
|
44
|
+
Create a presentation in the `/slidev/` directory:
|
|
45
|
+
|
|
46
|
+
```markdown title="slidev/introduction.md"
|
|
47
|
+
---
|
|
48
|
+
theme: "@sp-days-framework/slidev-theme-sykehuspartner"
|
|
49
|
+
title: Introduction to Docker
|
|
50
|
+
description: Learn containerization fundamentals
|
|
51
|
+
author: Your Name
|
|
52
|
+
layout: cover
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
# Introduction to Docker
|
|
56
|
+
## Containerization Made Simple
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
# What is Docker?
|
|
61
|
+
|
|
62
|
+
Docker is a platform for developing, shipping, and running applications in containers.
|
|
63
|
+
```
|
|
64
|
+
### 2. Live Preview During Development
|
|
65
|
+
|
|
66
|
+
Run Slidev directly to work on your presentation with hot-reload:
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
npm run slidev ./slidev/my-presentation.md
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
This opens your presentation in the browser with live updates as you edit.
|
|
73
|
+
|
|
74
|
+
### 3. View in Docusaurus
|
|
75
|
+
|
|
76
|
+
Build your Docusaurus site to see presentations integrated:
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
npm run build
|
|
80
|
+
npm run serve
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
Open the page and select "Slides" in the navbar to see the overview gallery.
|
|
84
|
+
|
|
85
|
+
:::note[Development Mode Limitation]
|
|
86
|
+
|
|
87
|
+
Presentations are **not built** during `npm run start`, [read more about it here.](./install.mdx#development-vs-production-modes)
|
|
88
|
+
|
|
89
|
+
:::
|
|
90
|
+
|
|
91
|
+
See [Setup](./install.mdx) for installation and configuration.
|
|
92
|
+
|
|
93
|
+
## How It Works
|
|
94
|
+
|
|
95
|
+
1. **Scan Phase** - Plugin scans the `/slidev/` directory for `.md` files during build
|
|
96
|
+
2. **Extract Metadata** - Frontmatter is parsed from each file (title, description, theme, author)
|
|
97
|
+
3. **Build Phase** - In production, Slidev builds each presentation to `static/slides/`
|
|
98
|
+
4. **Generate Overview** - Creates an interactive overview page (default: `/slidev`) with previews
|
|
99
|
+
5. **Serve** - Built presentations are accessible via unique URLs
|
package/docs/install.mdx
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
---
|
|
2
|
+
sidebar_position: 1.1
|
|
3
|
+
sidebar_custom_props:
|
|
4
|
+
section: "Setup"
|
|
5
|
+
section_position: 1
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
import Tabs from "@theme/Tabs";
|
|
9
|
+
import TabItem from "@theme/TabItem";
|
|
10
|
+
|
|
11
|
+
## Installation
|
|
12
|
+
|
|
13
|
+
:::tip[Already Included]
|
|
14
|
+
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!
|
|
15
|
+
:::
|
|
16
|
+
|
|
17
|
+
Install the Docusaurus plugin using your preferred package manager:
|
|
18
|
+
|
|
19
|
+
<Tabs>
|
|
20
|
+
<TabItem value="npm" label="npm" default>
|
|
21
|
+
```bash
|
|
22
|
+
npm install @sp-days-framework/docusaurus-plugin-slidev
|
|
23
|
+
```
|
|
24
|
+
</TabItem>
|
|
25
|
+
<TabItem value="yarn" label="Yarn">
|
|
26
|
+
```bash
|
|
27
|
+
yarn add @sp-days-framework/docusaurus-plugin-slidev
|
|
28
|
+
```
|
|
29
|
+
</TabItem>
|
|
30
|
+
</Tabs>
|
|
31
|
+
|
|
32
|
+
Install Slidev dependencies:
|
|
33
|
+
|
|
34
|
+
<Tabs>
|
|
35
|
+
<TabItem value="sp-theme" label="Sykehuspartner Theme" default>
|
|
36
|
+
```bash
|
|
37
|
+
npm install @sp-days-framework/slidev-theme-sykehuspartner
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Includes everything needed for Sykehuspartner branded presentations.
|
|
41
|
+
</TabItem>
|
|
42
|
+
<TabItem value="default" label="Default Theme">
|
|
43
|
+
```bash
|
|
44
|
+
npm install @slidev/theme-default
|
|
45
|
+
```
|
|
46
|
+
</TabItem>
|
|
47
|
+
</Tabs>
|
|
48
|
+
|
|
49
|
+
Add the plugin to your `docusaurus.config.js`:
|
|
50
|
+
|
|
51
|
+
```js title="docusaurus.config.js" {2,4}
|
|
52
|
+
module.exports = {
|
|
53
|
+
staticDirectories: ["static"],
|
|
54
|
+
|
|
55
|
+
plugins: ["@sp-days-framework/docusaurus-plugin-slidev"],
|
|
56
|
+
};
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
:::note
|
|
60
|
+
The `static` directory is required for serving built presentations.
|
|
61
|
+
:::
|
|
62
|
+
|
|
63
|
+
**Optional:** Add the `slidev` script for live preview during development:
|
|
64
|
+
|
|
65
|
+
```json title="package.json" {4}
|
|
66
|
+
{
|
|
67
|
+
"scripts": {
|
|
68
|
+
"docusaurus": "docusaurus",
|
|
69
|
+
"slidev": "slidev"
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## Configuration
|
|
75
|
+
|
|
76
|
+
### Basic Plugin Setup
|
|
77
|
+
|
|
78
|
+
The plugin works with default settings:
|
|
79
|
+
|
|
80
|
+
```js title="docusaurus.config.js"
|
|
81
|
+
module.exports = {
|
|
82
|
+
staticDirectories: ["static"],
|
|
83
|
+
plugins: ["@sp-days-framework/docusaurus-plugin-slidev"],
|
|
84
|
+
};
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### Plugin Options
|
|
88
|
+
|
|
89
|
+
Customize the plugin behavior:
|
|
90
|
+
|
|
91
|
+
```js title="docusaurus.config.js"
|
|
92
|
+
module.exports = {
|
|
93
|
+
plugins: [
|
|
94
|
+
[
|
|
95
|
+
"@sp-days-framework/docusaurus-plugin-slidev",
|
|
96
|
+
{
|
|
97
|
+
sourceDir: "./slidev",
|
|
98
|
+
outputDir: "slides",
|
|
99
|
+
theme: "@sp-days-framework/slidev-theme-sykehuspartner",
|
|
100
|
+
overviewPath: "/presentations",
|
|
101
|
+
},
|
|
102
|
+
],
|
|
103
|
+
],
|
|
104
|
+
};
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
Common options:
|
|
108
|
+
|
|
109
|
+
| Option | Type | Default | Description |
|
|
110
|
+
| ----------------- | --------- | ------------------------------------- | ------------------------------------------------------------------ |
|
|
111
|
+
| `sourceDir` | `string` | `'./slidev'` | Directory to scan for Slidev markdown files |
|
|
112
|
+
| `outputDir` | `string` | `'slides'` | Output directory inside `static/` for built presentations |
|
|
113
|
+
| `theme` | `string` | `undefined` | Global theme override for all presentations |
|
|
114
|
+
| `overviewPath` | `string` | `'/slidev'` | URL path for the auto-generated overview page |
|
|
115
|
+
| `overviewTitle` | `string` | `'Slidev Presentations'` | Title for the overview page |
|
|
116
|
+
|
|
117
|
+
See [Advanced Configuration](./advanced-configuration.mdx) for all options.
|
|
118
|
+
|
|
119
|
+
### Frontmatter Configuration
|
|
120
|
+
|
|
121
|
+
Configure individual presentations:
|
|
122
|
+
|
|
123
|
+
```markdown title="slidev/introduction.md"
|
|
124
|
+
---
|
|
125
|
+
theme: "@sp-days-framework/slidev-theme-sykehuspartner"
|
|
126
|
+
title: Introduction to Docker
|
|
127
|
+
description: Learn containerization fundamentals
|
|
128
|
+
author: Your Name
|
|
129
|
+
layout: cover
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
# Introduction to Docker
|
|
133
|
+
## Containerization Made Simple
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
Common frontmatter options:
|
|
137
|
+
|
|
138
|
+
| Option | Description |
|
|
139
|
+
| ------------- | ---------------------------------------------- |
|
|
140
|
+
| `theme` | Theme to use (overrides plugin global theme) |
|
|
141
|
+
| `title` | Presentation title |
|
|
142
|
+
| `description` | Brief description for overview page |
|
|
143
|
+
| `author` | Author name(s) |
|
|
144
|
+
| `layout` | Layout for the slide (e.g., `cover`, `intro`) |
|
|
145
|
+
|
|
146
|
+
## Development vs Production Modes
|
|
147
|
+
|
|
148
|
+
The plugin operates differently in development and production modes due to technical limitations:
|
|
149
|
+
|
|
150
|
+
**Why no live preview in development?**
|
|
151
|
+
- Slidev's CLI can only run one presentation at a time
|
|
152
|
+
- Building presentations takes 5-10+ seconds each
|
|
153
|
+
- Running builds during development would significantly slow down the dev server
|
|
154
|
+
|
|
155
|
+
This design choice prioritizes developer experience by keeping the documentation development workflow fast.
|
|
156
|
+
|
|
157
|
+
### Development Mode (`npm run start`)
|
|
158
|
+
|
|
159
|
+
- Presentations are **not built** automatically
|
|
160
|
+
- Overview page shows "Build Required" badges
|
|
161
|
+
- Much faster startup time
|
|
162
|
+
|
|
163
|
+
**Use for:** Active documentation development
|
|
164
|
+
|
|
165
|
+
### Production Mode (`npm run build`)
|
|
166
|
+
|
|
167
|
+
- All presentations are **automatically built**
|
|
168
|
+
- Overview page shows interactive preview thumbnails
|
|
169
|
+
- Presentations are fully functional
|
|
170
|
+
|
|
171
|
+
**Use for:** Deploying to production or testing integration
|
|
172
|
+
|
|
173
|
+
### Recommended Workflow
|
|
174
|
+
|
|
175
|
+
<Tabs>
|
|
176
|
+
<TabItem value="slides" label="Working on Slides" default>
|
|
177
|
+
```bash
|
|
178
|
+
# Live preview with hot-reload
|
|
179
|
+
npm run slidev ./slidev/your-presentation.md
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
Edit your presentation and see changes instantly.
|
|
183
|
+
</TabItem>
|
|
184
|
+
<TabItem value="verify" label="Verify Integration">
|
|
185
|
+
```bash
|
|
186
|
+
# Build and serve to see final result
|
|
187
|
+
npm run build
|
|
188
|
+
npm run serve
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
Navigate to `/slidev` to see the overview page.
|
|
192
|
+
</TabItem>
|
|
193
|
+
<TabItem value="docs" label="Working on Docs">
|
|
194
|
+
```bash
|
|
195
|
+
# Fast development server (slides not built)
|
|
196
|
+
npm run start
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
Focus on documentation without waiting for slide builds.
|
|
200
|
+
</TabItem>
|
|
201
|
+
</Tabs>
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="256" height="218" viewBox="0 0 256 218">
|
|
2
|
+
<path fill="#fff" d="M126.031 45.949h110.277v44.636H126.031z" />
|
|
3
|
+
<path fill="#3ecc5f" d="M26.256 191.672c-9.712 0-18.173-5.287-22.715-13.128A26.1 26.1 0 0 0 0 191.672c0 14.501 11.755 26.256 26.256 26.256h26.257v-26.256z" />
|
|
4
|
+
<path fill="#3ecc5f" d="m144.385 53.006l91.923-5.744V34.133c0-14.501-11.756-26.256-26.256-26.256H91.898l-3.282-5.685c-1.46-2.527-5.106-2.527-6.564 0L78.77 7.877l-3.282-5.685c-1.46-2.527-5.106-2.527-6.564 0l-3.282 5.685l-3.282-5.685c-1.46-2.527-5.106-2.527-6.564 0l-3.283 5.685l-.085.004l-5.438-5.437c-2.062-2.062-5.583-1.12-6.34 1.7l-1.795 6.7l-6.818-1.828c-2.818-.754-5.397 1.824-4.64 4.643l1.826 6.817l-6.7 1.795c-2.818.756-3.762 4.278-1.7 6.34l5.437 5.438l-.003.084l-5.686 3.282c-2.526 1.459-2.526 5.106 0 6.564l5.686 3.283l-5.686 3.282c-2.526 1.458-2.526 5.105 0 6.564l5.686 3.282l-5.686 3.282c-2.526 1.458-2.526 5.105 0 6.564l5.686 3.282l-5.686 3.282c-2.526 1.459-2.526 5.106 0 6.564l5.686 3.282l-5.686 3.282c-2.526 1.459-2.526 5.106 0 6.564l5.686 3.282l-5.686 3.282c-2.526 1.459-2.526 5.106 0 6.565l5.686 3.282l-5.686 3.282c-2.526 1.458-2.526 5.105 0 6.564l5.686 3.282l-5.686 3.282c-2.526 1.458-2.526 5.105 0 6.564l5.686 3.282l-5.686 3.282c-2.526 1.459-2.526 5.106 0 6.564l5.686 3.282l-5.686 3.282c-2.526 1.459-2.526 5.106 0 6.564l5.686 3.282l-5.686 3.282c-2.526 1.459-2.526 5.106 0 6.565l5.686 3.282l-5.686 3.282c-2.526 1.458-2.526 5.105 0 6.564l5.686 3.282c0 14.501 11.755 26.256 26.256 26.256h157.539c14.5 0 26.256-11.755 26.256-26.256V86.646l-91.923-5.745c-7.365-.46-13.102-6.568-13.102-13.947c0-7.38 5.737-13.487 13.102-13.948" />
|
|
5
|
+
<path fill="#3ecc5f" d="M183.795 217.928h39.384v-52.513h-39.384z" />
|
|
6
|
+
<path fill="#44d860" d="M249.436 185.108c-.288 0-.562.048-.839.084c-.05-.197-.097-.395-.152-.592a6.563 6.563 0 0 0-2.527-12.62c-1.494 0-2.856.52-3.96 1.36a35 35 0 0 0-.44-.442a6.5 6.5 0 0 0 1.328-3.92a6.563 6.563 0 0 0-12.602-2.573c-.195-.055-.39-.1-.584-.15c.035-.278.084-.552.084-.84a6.563 6.563 0 0 0-6.565-6.564a6.563 6.563 0 0 0-6.564 6.564c0 .288.049.562.084.84c-.194.05-.39.095-.584.15a6.563 6.563 0 0 0-12.602 2.572c0 1.477.505 2.824 1.328 3.921c-4.88 4.769-7.918 11.413-7.918 18.774c0 14.501 11.755 26.256 26.256 26.256c12.26 0 22.528-8.415 25.418-19.776c.277.035.551.084.839.084a6.563 6.563 0 0 0 6.564-6.564a6.563 6.563 0 0 0-6.564-6.564" />
|
|
7
|
+
<path fill="#3ecc5f" d="M196.923 139.159h39.385v-26.256h-39.385z" />
|
|
8
|
+
<path fill="#44d860" d="M249.436 129.313a3.282 3.282 0 1 0 0-6.564c-.143 0-.281.025-.419.042c-.026-.099-.048-.197-.076-.296a3.283 3.283 0 0 0-1.264-6.31c-.747 0-1.429.258-1.98.68a9 9 0 0 0-.22-.22a3.25 3.25 0 0 0 .664-1.962a3.282 3.282 0 0 0-6.302-1.286a13 13 0 0 0-3.531-.494c-7.25 0-13.129 5.878-13.129 13.128s5.88 13.128 13.129 13.128c1.226 0 2.406-.181 3.531-.495a3.282 3.282 0 0 0 6.302-1.285c0-.74-.252-1.414-.665-1.962q.113-.108.221-.22c.551.421 1.233.68 1.98.68a3.282 3.282 0 0 0 1.264-6.31c.028-.098.05-.198.076-.296c.138.017.276.042.419.042" />
|
|
9
|
+
<path d="M78.77 50.544a3.28 3.28 0 0 1-3.283-3.282c0-5.43-4.416-9.847-9.846-9.847s-9.846 4.417-9.846 9.847a3.282 3.282 0 1 1-6.564 0c0-9.05 7.36-16.41 16.41-16.41s16.41 7.36 16.41 16.41a3.28 3.28 0 0 1-3.282 3.282" />
|
|
10
|
+
<path fill="#ffff50" d="M131.282 217.928h78.77c14.5 0 26.256-11.755 26.256-26.256V99.774h-78.77c-14.501 0-26.256 11.755-26.256 26.257z" />
|
|
11
|
+
<path d="M216.641 140.472h-65.692a1.312 1.312 0 1 1 0-2.626h65.692a1.312 1.312 0 1 1 0 2.626m0 26.256h-65.692a1.312 1.312 0 1 1 0-2.625h65.692a1.312 1.312 0 1 1 0 2.625m0 26.257h-65.692a1.312 1.312 0 1 1 0-2.626h65.692a1.312 1.312 0 1 1 0 2.626m0-65.398h-65.692a1.312 1.312 0 1 1 0-2.626h65.692a1.312 1.312 0 1 1 0 2.626m0 26.013h-65.692a1.312 1.312 0 1 1 0-2.626h65.692a1.312 1.312 0 1 1 0 2.626m0 26.256h-65.692a1.312 1.312 0 1 1 0-2.625h65.692a1.312 1.312 0 1 1 0 2.625m19.667-121.289c-.016 0-.03-.008-.045-.007c-4.057.138-5.976 4.196-7.67 7.776c-1.766 3.74-3.133 6.174-5.373 6.1c-2.48-.089-3.898-2.89-5.4-5.856c-1.724-3.404-3.694-7.266-7.828-7.122c-3.999.137-5.925 3.668-7.623 6.783c-1.808 3.32-3.038 5.337-5.41 5.244c-2.53-.092-3.875-2.37-5.43-5.006c-1.735-2.935-3.74-6.236-7.793-6.123c-3.93.135-5.862 3.131-7.566 5.776c-1.802 2.797-3.065 4.5-5.468 4.4c-2.59-.094-3.928-1.983-5.476-4.171c-1.738-2.46-3.697-5.242-7.739-5.107c-3.844.131-5.775 2.585-7.478 4.75c-1.617 2.053-2.88 3.678-5.551 3.576a1.314 1.314 0 0 0-.095 2.626c3.96.132 5.967-2.365 7.709-4.578c1.545-1.964 2.879-3.66 5.505-3.748c2.528-.108 3.714 1.463 5.507 3.997c1.703 2.408 3.635 5.139 7.524 5.279c4.073.137 6.033-2.908 7.769-5.602c1.552-2.408 2.89-4.486 5.448-4.574c2.354-.088 3.635 1.773 5.442 4.833c1.702 2.884 3.631 6.152 7.597 6.296c4.103.142 6.084-3.44 7.81-6.61c1.495-2.741 2.907-5.331 5.407-5.417c2.354-.055 3.582 2.094 5.397 5.685c1.697 3.352 3.62 7.148 7.648 7.294q.111.004.222.004c4.022 0 5.93-4.037 7.62-7.607c1.496-3.164 2.911-6.145 5.34-6.266z" />
|
|
12
|
+
<path fill="#3ecc5f" d="M105.026 217.928h52.512v-52.513h-52.512z" />
|
|
13
|
+
<path fill="#44d860" d="M183.795 185.108c-.288 0-.562.048-.839.084c-.05-.197-.097-.395-.152-.592a6.563 6.563 0 0 0-2.527-12.62c-1.494 0-2.856.52-3.96 1.36a35 35 0 0 0-.44-.442a6.5 6.5 0 0 0 1.328-3.92a6.563 6.563 0 0 0-12.602-2.573c-.195-.055-.39-.1-.584-.15c.035-.278.084-.552.084-.84a6.563 6.563 0 0 0-6.565-6.564a6.563 6.563 0 0 0-6.564 6.564c0 .288.049.562.084.84c-.194.05-.39.095-.584.15a6.563 6.563 0 0 0-12.602 2.572c0 1.477.505 2.824 1.328 3.921c-4.88 4.769-7.918 11.413-7.918 18.774c0 14.501 11.755 26.256 26.256 26.256c12.26 0 22.528-8.415 25.418-19.776c.277.035.551.084.839.084a6.563 6.563 0 0 0 6.564-6.564a6.563 6.563 0 0 0-6.564-6.564" />
|
|
14
|
+
<path fill="#3ecc5f" d="M105.026 139.159h52.512v-26.256h-52.512z" />
|
|
15
|
+
<path fill="#44d860" d="M170.667 129.313a3.282 3.282 0 1 0 0-6.564c-.143 0-.281.025-.42.042q-.036-.148-.075-.296a3.283 3.283 0 0 0-1.265-6.31c-.747 0-1.428.258-1.98.68a9 9 0 0 0-.22-.22a3.25 3.25 0 0 0 .664-1.962a3.282 3.282 0 0 0-6.301-1.286a13 13 0 0 0-3.532-.494c-7.249 0-13.128 5.878-13.128 13.128s5.88 13.128 13.128 13.128a13 13 0 0 0 3.532-.495a3.282 3.282 0 0 0 6.301-1.285a3.25 3.25 0 0 0-.664-1.962q.113-.108.22-.22c.552.421 1.233.68 1.98.68a3.282 3.282 0 0 0 1.265-6.31l.076-.296c.138.017.276.042.419.042" />
|
|
16
|
+
<path d="M183.795 32.492c-.21 0-.433-.026-.643-.065a3.3 3.3 0 0 1-.617-.184a3.4 3.4 0 0 1-.566-.302a5 5 0 0 1-.5-.407c-.142-.158-.287-.315-.405-.499a3.5 3.5 0 0 1-.303-.564a3.4 3.4 0 0 1-.248-1.26c0-.21.026-.434.065-.644s.105-.407.183-.617c.08-.197.185-.38.303-.565c.118-.17.263-.34.406-.498c.159-.145.328-.29.499-.407a3.2 3.2 0 0 1 1.183-.486a3 3 0 0 1 1.286 0c.209.04.42.105.617.184c.196.078.38.183.565.302c.17.118.34.262.499.407c.144.157.288.328.407.498c.118.184.223.368.301.565c.08.21.145.407.184.617c.038.21.066.433.066.643a3.33 3.33 0 0 1-.958 2.324a5 5 0 0 1-.5.407a3.4 3.4 0 0 1-.564.302a3.4 3.4 0 0 1-.617.184c-.21.04-.433.065-.643.065m26.256-1.641a3.35 3.35 0 0 1-2.325-.958a5 5 0 0 1-.405-.499a3.5 3.5 0 0 1-.304-.564a3.4 3.4 0 0 1-.248-1.26c0-.867.355-1.707.957-2.324c.16-.145.328-.29.5-.407a3.2 3.2 0 0 1 1.182-.486c.42-.092.866-.092 1.287 0c.208.04.42.105.617.184c.195.078.38.183.564.302c.17.118.34.262.499.407c.603.617.958 1.457.958 2.323a3.4 3.4 0 0 1-.249 1.261c-.092.196-.184.38-.302.564c-.118.17-.263.341-.407.499a5 5 0 0 1-.499.407a3.4 3.4 0 0 1-.564.302a3.4 3.4 0 0 1-.617.184c-.21.039-.434.065-.644.065" />
|
|
17
|
+
</svg>
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sp-days-framework/docusaurus-plugin-slidev",
|
|
3
|
-
"version": "1.0
|
|
3
|
+
"version": "1.1.0-beta2",
|
|
4
4
|
"description": "A Docusaurus plugin to integrate Slidev presentations into your Docusaurus site.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
7
|
-
"url": "https://github.com/helse-sorost/sp-days-framework",
|
|
7
|
+
"url": "git+https://github.com/helse-sorost/sp-days-framework.git",
|
|
8
8
|
"directory": "docusaurus-plugin-slidev"
|
|
9
9
|
},
|
|
10
10
|
"keywords": [
|
|
@@ -22,6 +22,8 @@
|
|
|
22
22
|
"types": "lib/index.d.ts",
|
|
23
23
|
"files": [
|
|
24
24
|
"lib/**/*",
|
|
25
|
+
"docs/**/*",
|
|
26
|
+
"publish-package-docs.js",
|
|
25
27
|
"README.md",
|
|
26
28
|
"LICENSE"
|
|
27
29
|
],
|
|
@@ -32,7 +34,8 @@
|
|
|
32
34
|
"types": "./lib/index.d.ts"
|
|
33
35
|
},
|
|
34
36
|
"./lib/theme/*": "./lib/theme/*",
|
|
35
|
-
"./lib/plugin/*": "./lib/plugin/*"
|
|
37
|
+
"./lib/plugin/*": "./lib/plugin/*",
|
|
38
|
+
"./publish-package-docs": "./publish-package-docs.js"
|
|
36
39
|
},
|
|
37
40
|
"publishConfig": {
|
|
38
41
|
"access": "public"
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Sykehuspartner HF
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
module.exports = {
|
|
9
|
+
id: 'slidev-integration-docs',
|
|
10
|
+
path: require('path').join(__dirname, 'docs'),
|
|
11
|
+
routeBasePath: 'package-docs/slidev-integration',
|
|
12
|
+
};
|