relequestual/gatsby-theme-waves — explained in plain English
Analysis updated 2026-07-19 · repo last pushed 2019-08-13
Create a step-by-step coding tutorial where code blocks update as the reader scrolls through explanations.
Build data visualization blog posts where charts and visuals change in sync with the narrative.
Write technical documentation that progressively walks readers through code evolution.
Develop interactive explainers that highlight specific lines or columns of code at each step.
| relequestual/gatsby-theme-waves | 3rd-eden/ircb.io | a15n/a15n | |
|---|---|---|---|
| Language | JavaScript | JavaScript | JavaScript |
| Last pushed | 2019-08-13 | 2016-11-16 | 2019-04-07 |
| Maintenance | Dormant | Dormant | Dormant |
| Setup difficulty | moderate | easy | easy |
| Complexity | 3/5 | 2/5 | 2/5 |
| Audience | developer | developer | general |
Figures from each repo's GitHub metadata at analysis time.
Requires an existing Gatsby site with MDX already configured, you must add the theme to gatsby-config and merge style settings.
Gatsby Theme Waves is a tool for people who write blog posts or documentation using MDX (a format that mixes Markdown with interactive components). It adds "scrollytelling" to your content, meaning elements on the page, like code snippets, images, charts, or maps, animate and change as the reader scrolls down. Instead of presenting a static block of code or a single image, you can guide readers through a progression, highlighting specific lines or swapping visuals step by step. At a high level, you wrap your content in a special component, like CodeWave. Inside that wrapper, you alternate between code blocks and regular Markdown text. As the reader scrolls through the text, the code block above or beside it updates to reflect what's being discussed. By default, the tool highlights the lines that changed between consecutive code blocks, but you can also manually specify which lines or even which columns within a line to highlight. This is useful for anyone writing technical tutorials, data visualizations, or explanatory blog posts on a Gatsby site. For example, if you're teaching someone how a piece of code evolves, say, building a function step by step, you can show each iteration alongside the explanation, so the reader sees the code change in sync with your narrative. The live demo linked in the project gives a clear sense of the effect. The project is still experimental, as noted in the README. Setting it up requires an existing Gatsby site with MDX already configured, and installation involves adding the theme to your Gatsby config and merging some style settings. The README doesn't go into much detail beyond code blocks, but it mentions that more "waves" (likely other types of animated components beyond code) and better documentation are coming.
A Gatsby theme that adds scroll-driven animations to MDX content, letting you create step-by-step tutorials where code snippets and visuals change as the reader scrolls.
Mainly JavaScript. The stack also includes Gatsby, MDX, JavaScript.
Dormant — no commits in 2+ years (last push 2019-08-13).
No license information provided in the README.
Setup difficulty is rated moderate, with roughly 30min to a first successful run.
Mainly developer.
This repo across BitVibe Labs
Verify against the repo before relying on details.