Make beautifully animated Slydes and presentations from XML with ease!

---

Slyde

• Slyde
  • What is Slyde?
  • Features
  • Installation
    • NPM package installation
    • Docker image installation
    • Building from source
  • Contributing
  • 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.

<presentation title="My First Slyde Presentation" by="Tygo van den Hurk">
  <slide title="Why you should use Slyde">
    <!-- These are my slide notes in case I forget what to say -->
    <point>It is super **fast and easy** to make slides</point>
    <point>The animations are **gorgeous**!</point>
    <point>Recipient only needs a browser to open it</point>
  </slide>
</presentation>

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, pull docker image, or building from source.

NPM package installation

To install Slyde using NPM, run the following command:

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 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, run the following command:

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:

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.

Licence

All files in this repository fall under a licence.