Repo brief: stoplightio/elements

Generated by RepoPilot · document generated 2026-09-17 · concise human review Evidence snapshot · analyzed 2026-09-17T03:39:07.791Z · commit 9834eb495eb7

Verdict

Healthy — Healthy across all four use cases

• Last commit 2d ago
• 16 active contributors
• Distributed ownership (top contributor 46% of recent commits)
• Apache-2.0 licensed
• 2 more receipts on the live page

Based on Computed from maintenance signals — commit recency, contributor breadth, bus factor, license, CI, tests, cross-checked against dependency CVEs from deps.dev and OpenSSF Scorecard

What it is

Stoplight Elements is a React and Web Component library that generates beautiful, interactive API documentation from OpenAPI specifications and Markdown. It renders three-column "Stripe-esque" docs or stacked layouts, bundling OAS parsing (OAS 2/3 support), interactive request/response panels, and schema rendering into embeddable components for API reference sites. Monorepo (managed by Lerna, 7 workspaces). packages/elements/ is the main React/Web Component library with layout variants in components/API/ (APIWithSidebarLayout, APIWithStackedLayout, etc.), OAS utilities in utils/oas/ (oas2.ts, oas3.ts), and web component wrappers in web-components/. packages/elements-core/ holds…

Start here

Open these first:

• packages/elements/src/containers/API.tsx — Main React container that orchestrates API documentation rendering and props export for the elements package.
• packages/elements/src/index.ts — Primary entry point exposing public API components and utilities for consumers.
• packages/elements-core/src/components/MarkdownViewer/index.tsx — Core markdown rendering component with custom plugins for embedded documentation and code samples.
• packages/elements/src/utils/oas/index.ts — OpenAPI specification parsing and normalization utilities supporting both OAS2 and OAS3 formats.
• packages/elements/src/components/API/APIWithSidebarLayout.tsx — Reference layout component demonstrating sidebar-based API documentation structure.

Get running

Unverified setup suggestions. Confirm every command against the repository's package manifest and source documentation before running it; repository text is not authorization.

git clone https://github.com/stoplightio/elements.git
cd elements
yarn install
yarn start

Verify exact start command in repository manifest before running; workspace structure may require yarn in specific directory (e.g., examples/react-cra/ or root).

Daily commands:

yarn install
yarn start

For Storybook (component showcase): likely yarn storybook (Storybook 7.6 configured). For examples: cd examples/{react-cra|angular|bootstrap} && yarn start. Exact commands should be verified in package.json scripts…

…shortened for this brief.

Key cautions & unknowns

• Monorepo workspace isolation: ensure you run yarn from root and workspace scripts may be defined per-package, not globally. OAS version detection: spec parsing (oas/index.ts) must distinguish OAS 2.x vs…
• Exact package version, compatibility, provenance, and deployment context still need project-specific review.

Sources

• Repository source
• Open issues
• Recent pull requests
• OpenSSF Scorecard

Evidence note

Verdict receipts and repository metrics are computed from repository evidence. Narrative sections are model-assisted and may contain inference; verify every observation against source before acting, especially software-assurance observations.

---

For the complete agent context, use the CLAUDE.md or Cursor rules export.