![\"the](\"https://github.com/Tygo-van-den-Hurk/Slyde/blob/16c702b4e5682d4c8ab8a2876f4c3d02f0cbc155/docs/assets/logo-standalone.svg\"){kind=logo}
\n \n
\n
Make beautifully animated Slydes and presentations from XML with ease!
\n\n Make beautifully animated Slydes and presentations from XML with ease!
\n![\"An](\"https://github.com/Tygo-van-den-Hurk/Slyde/blob/16c702b4e5682d4c8ab8a2876f4c3d02f0cbc155/docs/assets/example-presentation.gif\")
\n\n## Features\n\n- Easily build beautifully animated presentations\n- Use markup to effortlessly style your text\n- Rich plugin system extend Slyde in under a minute\n- Exports are offline-ready HTML files\n- Embed images in your presentation\n\n## Installation\n\nThere 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).\n\n### NPM package installation\n\nTo install Slyde using NPM, run the following command:\n\n```Shell\nnpm install @tygo-van-den-hurk/slyde\n```\n\nYou can also install Slyde in your path by adding the `--global` flag. You might need to restart your session after installation. \n\nTo 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.\n\n### Docker image installation\n\nTo install and run slyde using [docker](http://docker.com), run the following command:\n\n```Shell\ndocker run -it --volume \"$PWD:/pwd\" --rm ghcr.io/tygo-van-den-hurk/slyde:latest compile\n```\n\n### Building from source\n\n> [!WARNING]\n> 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.\n\nYou can install slyde as a dependency to your project, run the following commands:\n\n```Shell\ngit clone http://github.com/tygo-van-den-hurk/slyde \"$PWD/slyde\"\ncd \"$PWD/slyde\"\nnpm ci\nnpm run build\ncd -\nnpm install \"$PWD/slyde\"\n```\n\nYou can also install Slyde in your path by adding the `--global` flag. You might need to restart your session after installation. \n\n\n## Licence\n\nAll files in this repository fall under a [licence](https://github.com/Tygo-van-den-Hurk/Slyde/blob/16c702b4e5682d4c8ab8a2876f4c3d02f0cbc155/LICENSE).\n","readmeFilename":"README.md"}