SpeyDocs — API Documentation Site

SpeyDocs Public API Documentation

SpeyBooks now has a dedicated documentation site at docs.speybooks.com. Every public endpoint, object schema, and authentication flow is documented with interactive examples.

What Shipped

• 252 pages generated — every resource, endpoint, and object schema has its own page with curl examples, JSON responses, and field-level documentation.
• Two-panel layout — content on the left, code examples on the right. Sticky code panels follow as you scroll through attributes and parameters.
• Full-text search — powered by Pagefind with a keyboard-first modal (⌘K / Ctrl+K / /). Indexes all content, excludes code examples from results.
• Light and dark themes — respects system preference with manual toggle. Code panels stay dark in both themes.
• Sidebar navigation — grouped by resource with method-coloured dots (green GET, blue POST, amber PATCH, red DELETE). Arrow key navigation and scroll persistence across page loads.
• Build-time compression — HTML, CSS, and JS minified automatically via astro-compress. ~966KB saved across all pages.

Markdown Rendering Fix

• YAML block scalar indentation — endpoint descriptions written as multi-line YAML were rendering as code blocks instead of formatted text. A dedent step now strips the common indent before passing to the markdown renderer.

Keyboard & Accessibility

• Visible-only arrow navigation — sidebar arrow keys skip items inside collapsed resource groups, preventing focus from disappearing into hidden elements.
• Left/Right on resource groups — ArrowRight opens a resource section, ArrowLeft closes it.
• Focus management — opening the mobile sidebar moves focus inside; closing it restores focus to the menu button.
• Global focus-visible fallback — ensures all interactive elements have visible keyboard focus indicators.

Infrastructure

• Sidebar scroll persistence — uses sessionStorage with pagehide and visibilitychange events. Scroll position restores via requestAnimationFrame after layout settles.
• Content Security Policy — wasm-unsafe-eval added to support Pagefind’s WebAssembly search index.
• Sitemap — auto-generated at build time for all 252 pages.