The Explorer

The Explorer is the heart of sdocs: an interactive component browser generated from .sdoc files in your project. Write a small doc file next to each Svelte component and the Explorer gives you live previews, auto-generated prop controls, extracted prop tables, and a searchable sidebar — with zero build configuration.

There are two ways to run it:

• Standalone — npx sdocs run starts the Explorer as its own dev server, no host app (or even an sdocs install) required.
• Embedded — mount the Explorer as a route inside your existing Vite or SvelteKit app.

In this section

• Getting Started — install and write your first doc
• Features
  • Prop extraction
  • Interactive controls
  • Theming & CSS switching
  • Sidebar
  • Routing
• Embedded in Vite / SvelteKit
• Configuration reference
• Types

The other entities

• The sdoc language — the .sdoc file format the Explorer renders
• CLI — run, build, and scaffold from the command line
• VS Code extension — .sdoc IntelliSense and one-click docs inside the editor