https://github.com/tygo-van-den-hurk/slyde
⚡ Make beautifully animated Slydes and presentations from XML with ease! ⚡
https://github.com/tygo-van-den-hurk/slyde
cli cli-app easy hacktoberfest plugin-support presentation presentation-slides presentation-tools server slyde typescript xml
Last synced: 4 months ago
JSON representation
⚡ Make beautifully animated Slydes and presentations from XML with ease! ⚡
- Host: GitHub
- URL: https://github.com/tygo-van-den-hurk/slyde
- Owner: Tygo-van-den-Hurk
- Created: 2025-10-20T21:00:04.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-12-20T16:13:22.000Z (6 months ago)
- Last Synced: 2025-12-22T15:49:17.807Z (6 months ago)
- Topics: cli, cli-app, easy, hacktoberfest, plugin-support, presentation, presentation-slides, presentation-tools, server, slyde, typescript, xml
- Language: TypeScript
- Homepage: https://tygo-van-den-hurk.github.io/Slyde/
- Size: 504 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Make beautifully animated Slydes and presentations from XML with ease!
# Slyde
- [Slyde](#slyde)
- [What is Slyde?](#what-is-slyde)
- [Features](#features)
- [Installation](#installation)
- [NPM package installation](#npm-package-installation)
- [Docker image installation](#docker-image-installation)
- [Building from source](#building-from-source)
- [Contributing](#contributing)
- [Licence](#licence)
## What is Slyde?
Slyde is a program to create professional beautifully animated presentations from XML. It is fast and easy, even for non-technical people.
```XML
It is super **fast and easy** to make slides
The animations are **gorgeous**!
Recipient only needs a browser to open it
```
This would output the following fully animated presentation:
## Features
- Easily build beautifully animated presentations
- Use markup to effortlessly style your text
- Rich plugin system extend Slyde in under a minute
- Exports are offline-ready HTML files
- Embed images in your presentation
## Installation
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).
### NPM package installation
To install Slyde using NPM, run the following command:
```Shell
npm install @tygo-van-den-hurk/slyde
```
You can also install Slyde in your path by adding the `--global` flag. You might need to restart your session after installation.
To install Slyde using npm from [GitHub' NPM registry](https://npm.pkg.github.com/) add the `--registry=https://npm.pkg.github.com/` option. This might require a personal access token from GitHub to function correctly.
### Docker image installation
To install and run slyde using [docker](http://docker.com), run the following command:
```Shell
docker run -it --volume "$PWD:/pwd" --rm ghcr.io/tygo-van-den-hurk/slyde:latest compile
```
### Building from source
> [!WARNING]
> 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.
You can install slyde as a dependency to your project, run the following commands:
```Shell
git clone http://github.com/tygo-van-den-hurk/slyde "$PWD/slyde"
cd "$PWD/slyde"
npm ci
npm run build
cd -
npm install "$PWD/slyde"
```
You can also install Slyde in your path by adding the `--global` flag. You might need to restart your session after installation.
## Contributing
If you would like to make Slyde better, see the [contributing guidelines](./CONTRIBUTING.md).
## Licence
All files in this repository fall under a [licence](./LICENSE).