Skip to main content

Quickstart ยท Reveal.js

Sharing Reveal.js decks with linkdown

Five steps from your source folder to a shareable link.

Your share URL survives edits

Fix a typo, rebuild, run linkdown update. The same URL keeps working โ€” no broken embeds, no fresh links to paste.

1.Install the CLI

Install the linkdown CLI:

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

linkdown login opens your browser to confirm the device.

linkdown login

3.Build

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.Share

Your deck is live at the URL printed in the terminal. The link survives edits โ€” see the call-out above.

linkdown share my-reveal-deck

Re-print the link any time with linkdown share <name>. Add --expiry 30d or --password secret to scope the link.

Updating an existing deck

Run linkdown update after edits. The share URL is preserved.

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

Other frameworks

Same five steps work for the other supported slide frameworks.