Docs

Rikiki documentation

A tiny Lit Web Components framework for technical presentations. Write a deck as plain HTML, serve the folder, give the talk.

A Rikiki deck is a folder of readable HTML. The first file isindex.html; the slides are <deck-*> elements inside one <deck-root>, and the framework loads from arikiki/ folder next to it. There is no build step: any static server serves the deck as written. The command line checks a deck in a real browser and delivers it as a single HTML file or a PDF.

Prerequisites. Writing and serving a deck needs a browser and a static server. The command line needs Node ^20.19.0 || >=22.12.0;check, render and export also need Playwright, an optional peer.

Where to start

Pick the entry point that matches what you came for.

New to Rikiki?

Install in a minute, write your first slide, learn the navigation keys.

→ Getting started

Looking up a component?

Every <deck-*> in one page · attributes, slots, tokens, parts.

→ Component library

Want to rebrand?

One layer of CSS custom properties · two themes ship, write a third by copy-paste.

→ Theming guide

Need a specific layout?

Patterns for code-on-left, side-by-side, three-column, big-number slides.

→ Recipes

Ready to deliver?

Run the deck checks, render pictures, bundle to one file, export a PDF.

→ Check and deliver

Design principles

Rikiki is opinionated about three things. The rest is up to you.

  1. Zero build for deck authors.A deck is a folder · drop it on any static host, it runs. No Node, no bundler, no node_modules to resurrect.
  2. Web standards over framework lore.Custom Elements and Shadow DOM (WHATWG HTML and DOM), ES modules (ECMAScript) and CSS custom properties (W3C) ship in every current browser engine: Blink, Gecko and WebKit.
  3. Light by default, extensible on demand.The initial load is 43 KB gzip · 26 KB of engine, the rest Lit and marked. The overview mode and the help overlay load on first use. Anything bigger ships as an optional module the deck imports.

Not the right tool when…

  • You want a WYSIWYG editor · Rikiki uses HTML source and a browser preview. It has no visual builder.
  • You need PowerPoint-style animation on shapes · an optional module adds slide-level fade, slide, zoom and flip transitions, not free-form timelines.
  • You want a hosted SaaS · there is none. You host the static files yourself.
  • You need PowerPoint export · Rikiki delivers standalone HTML and PDF, not .pptx.
  • Your environment forbids Web Components · Custom Elements and Shadow DOM are part of the runtime.

For everything else · keep reading.

Next

  • Getting started · install, write the first deck, serve it, check and deliver it.
  • Cheatsheet · the five components a first talk needs.