You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/index.md
+47Lines changed: 47 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,3 +28,50 @@ This would output the following fully animated presentation:
28
28
<imgsrc="https://raw.githubusercontent.com/Tygo-van-den-Hurk/Slyde/main/docs/assets/example-presentation.gif"width="100%"style="border-radius:var(--radius-xl);"alt="An example Slyde presentation based on the previous example XML template">
29
29
30
30
To see a run down of how we made this slide [see the basics](./basics.md).
31
+
32
+
## Installation
33
+
34
+
There are several ways to install Slyde: [installing an npm package](#npm-package-installation), [pull docker image](#docker-image-installation), or [building from source](#building-from-source).
35
+
36
+
### NPM package installation
37
+
38
+
> [!NOTE]
39
+
> This might require a token from GitHub to function.
40
+
41
+
To install Slyde using [npm](https://www.npmjs.com/) from [GitHub' NPM registry](https://npm.pkg.github.com/), run the following command:
You can also install Slyde in your path by adding the `--global` flag. You might need to restart your session after installation.
48
+
49
+
### Docker image installation
50
+
51
+
To install and run slyde using [docker](http://docker.com), run the following command:
52
+
53
+
```Shell
54
+
docker run --volume "$PWD:/src" --rm ghcr.io/tygo-van-den-hurk/slyde:latest compile /src/slyde.xml --output /src/slyde.html
55
+
```
56
+
57
+
### Building from source
58
+
59
+
> [!WARNING]
60
+
> This option is not recommended even if you chose to install `--global` as this makes your system harder to replicate. The previous options are recommended for almost all use cases.
61
+
62
+
You can install slyde as a dependency to your project, run the following commands:
0 commit comments