Quickstart · Reveal.js

Sharing Reveal.js decks

Reveal.js is the classic HTML+JS slide framework — write index.html, drop in a <script> tag, ship. This guide takes you from a local deck to a public share URL in five steps.

1.Install the CLI

The linkdown Rust binary installs from a single script. Pipe it to bash:

curl -fsSL https://lnkdwn.com/install.sh | bash

The script is mirrored at /install.sh. Manual install options are in the CLI reference.

2.Authenticate

One-time login opens your browser and pairs the CLI with your account via OAuth2 device flow. The token is stored in your OS keychain.

linkdown login

3.Build the deck

Reveal.js has no canonical build step — static index.html is the deliverable. Copy the official template or run the basic setup:

npx degit revealjs/deck my-reveal-deck && cd my-reveal-deck

The CLI auto-detects Reveal.js by looking for a <script> tag pointing at a reveal.js build in your index.html. If your project has a custom build step (e.g. npm run build), pass it via --build-cmd on the create call.

4.Upload

Point the CLI at the folder containing your built index.html:

linkdown create ./my-reveal-deck --name my-reveal-deck

If auto-detection misses it, force the framework with --framework revealjs.

5.Get a share URL

The CLI prints the share link on success. If you closed the terminal, generate it again:

linkdown share my-reveal-deck

Add --expiry 30d or --password secret to scope the link.

Updating an existing deck

When you change the source, rebuild and re-upload. The share URL from step 5 is preserved so existing viewers keep working (per PR #117):

linkdown update ./my-reveal-deck --name my-reveal-deck

Other frameworks

Same five steps work for the other supported slide frameworks.

Sharing Marp decks Sharing Slidev decks Full CLI reference