Getting Started

Waypoint for Docusaurus helps readers work through long docs one step at a time. Readers choose between the whole guide and a focused step view, with navigation and optional checklists.

Try the demo guide to see it in action.

Installation

npm

npm install @homotechsual/docusaurus-theme-waypoint

Yarn

yarn add @homotechsual/docusaurus-theme-waypoint

pnpm

pnpm add @homotechsual/docusaurus-theme-waypoint

Bun

bun add @homotechsual/docusaurus-theme-waypoint

Waypoint is a theme for Docusaurus 3. Add it to the themes list in your site's configuration:

// docusaurus.config.ts
export default {
  themes: ['@homotechsual/docusaurus-theme-waypoint'],
};

Opt in a guide

Add waypoint: true to a doc's front matter:

---
waypoint: true
---

# My guide

An introduction appears as the Overview step.

## Install

Install the prerequisites.

## Configure

Configure your project.

By default, level 2 and level 3 headings start new steps. The reader can switch back to the full page at any time. Docs without the front matter flag are unchanged. Without JavaScript, the complete guide remains visible.

See Configuration to adjust the theme, or Checklists to add progress ticks.