Display Modes

Each API Doc can display its content in one of two modes. This is set per-doc in the General tab under Display Format, or site-wide in Settings.

One-Page Mode (onepage)

All collections and all endpoints are rendered on a single scrollable page.

Best for: Small to medium APIs with a manageable number of endpoints.

Frontend behavior:

• The entire API renders on one page
• The left sidebar navigation links jump to anchor positions within the page
• The right code panel updates as the visitor scrolls to each endpoint (JavaScript-driven)

Multi-Page Mode (multi)

Each collection and endpoint gets its own URL. The doc has three navigation levels:

Best for: Large APIs with many endpoints where a single page would be overwhelming.

Frontend behavior:

• Browser Back/Forward navigation works naturally (each endpoint is a real URL)
• Page <title> changes to reflect the current endpoint or collection name
• Prev/Next navigation links appear at the bottom of each endpoint page

[!NOTE]
In Multi-page mode, invalid collection or endpoint URLs (e.g., a slug that does not exist) return a proper 404 Not Found response. One-page docs receiving extra path segments redirect to the root permalink with a 301.