observable-framework-project-structure

Explain directory layout, file conventions, and routing for Observable Framework projects.

Updated Feb 28, 2026
One-click install
npx skills add https://github.com/spqw/skill-observable-framework --skill observable-framework-project-structure
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: observable-framework-project-structure
Source: https://github.com/spqw/skill-observable-framework/tree/main/skills/observable-framework-project-structure
Command: npx skills add https://github.com/spqw/skill-observable-framework --skill observable-framework-project-structure

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill clarifies the organization and conventions of files and directories within an Observable Framework project, making it easier to navigate and manage your codebase.

Core Features & Use Cases

  • Directory Structure: Explains the purpose of key directories like src, components, and data.
  • File Conventions: Details the roles of files such as index.md, observablehq.config.js, and data loaders.
  • Routing: Illustrates how file names and locations map to URL routes.
  • Use Case: When starting a new Observable Framework project or onboarding a new team member, this Skill provides a clear map of the project's architecture.

Quick Start

Review the typical directory structure for an Observable Framework project.

Frequently Asked Questions about observable-framework-project-structure

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What is the standard directory layout for an Observable Framework project?

The standard directory layout for an Observable Framework project organizes files into key directories like `src` for components and `data` for data loaders. This structure clarifies file conventions and maps source directories to web routes for maintainability.

How does file-based routing work in the Observable Framework?

File-based routing in the Observable Framework maps Markdown file names and locations directly to URL routes. Files like `index.md` automatically generate corresponding web routes, simplifying navigation and project architecture without manual route configuration.

What is the purpose of observablehq.config.js in an Observable Framework codebase?

The `observablehq.config.js` file defines core configuration settings for an Observable Framework codebase. It works alongside the standard directory layout to establish project conventions, manage data loading locations, and control overall application behavior.

Where should data loaders be placed in an Observable Framework project structure?

Data loaders should be placed in the designated `data` directory within an Observable Framework project structure. Organizing data loading locations in this specific directory maintains project comprehension and ensures data is routed correctly to components.

How do I organize components in an Observable Framework application?

You organize components in an Observable Framework application by placing them in the `src` directory. This standard directory layout separates component organization from data loading locations, facilitating project comprehension and maintainability for developers.