Getting Started

Installation

Slipshow compiles files written in a specific syntax (an extension of markdown), to a standalone file viewable offline in any web browser. This page is about the different ways to get access to the slipshow compiler: either by downloading and installing it, or by using a webservice.

• If you want to try slipshow without installing anything, you should use a webservice.

• If you want to use slipshow and can install it, you should use precompiled binaries.

• If there are no precompiled binaries for your system, and you are an opam user, you should use it.

• Otherwise, you should use npm.

Using a webservice

The simplest way to get started with slipshow is to go to sliphub.choum.net. This will open a page with an editor on the left, and a preview on the right.

Currently, the interface is quite minimal. Your progress is saved “live” and you can even do collaborative editing: two people editing the same document.

Remember the link to be able to come back to your document later! And save your work locally. This is still highly experimental.

Using precompiled binaries

Download the binary corresponding to your environment in the release page of the project. You might want to install the binary in the archive, e.g. in /usr/local/bin.

Using opam

Just run the following command:

$ opam pin slipshow git+https://github.com/panglesd/slipshow.git
$ # test your installation:
$ slipshow --help

and you are done!

Using npm

For a reason described below, installing slipshow through npm will install a slightly slower version, with less functionalities. So, installing it like that is somehow discouraged, unless you don’t mind the missing functionalities!

$ npm install slipshow
$ # Test your installation
$ npx slipshow -- --help

So, here are the limitations of the npm version of slipshow: - It is slower (might not be a problem, since it still is very fast!) - The --watch argument is not (yet) available. This argument lets slipshow compiler run in watch mode, every file modifications triggering a recompilation. You can use inotifywait ou fswatch to mimick the behaviour! - The --serve argument is not (yet) available. This argument lets slipshow serve the file through an http server, and provide live-reloading on file changes! You can use the live-reload npm package to mimick the behaviour.

The reason for such limitations is that slipshow is written in OCaml, not javascript. Luckily, OCaml can compile to javascript! But for some functionalities, like file-watching (which relies on a C library), this compilation cannot be meaningful.

Your first presentation

Copy and paste the following example file in my-first-slipshow.md:

# My first presentation!

Here is a paragraph.

{pause}

- some items
- and some others!

{.definition pause up}
This is a definition

This is the source file that you can edit when writing your presentation. For the syntax, see the syntax reference.

Now, compile the file:

$ slipshow my-first-slipshow.md
$ # or npx slipshow my-first-slipshow.md if you installed it through npm

Your presentation has been compiled to a standalone file named my-first-slipshow.html! You can open it in your favorite browser to see the result. You can send the file to anyone, they can open it and it will work, even without internet connection!

For a description of the syntax, you can read the syntax reference. For a tutorial on the many features of slipshow, you can have a look at the tutorial.