# stoplightio/elements

Build beautiful, interactive API Docs with embeddable React or Web Components, powered by OpenAPI and Markdown.

Repository: https://github.com/stoplightio/elements
Canonical: https://ross.abutalabs.com/products/stoplightio-elements
Homepage: https://stoplight.io/open-source/elements/
Language: TypeScript
License: Apache-2.0
License Family: permissive
Topics: api, api-documentation, openapi3, openapi3-1, react, openapi, gatsby, hacktoberfest, stoplight-elements, stoplight-oss, swagger-oss
Last push: 2026-08-26T15:11:56+00:00

## Health v2 (maintenance only)
Score: 67/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 99, release rhythm 8, longevity 100
- inputs: {"age_days": 2680, "days_push": 7, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 2453, forks 259 (observed 2026-08-28T04:06:53.024370+00:00)

## What it is
Stoplight Elements is an open-source set of React and Web Components for building beautiful, interactive API documentation from OpenAPI documents and Markdown. It supports three-column 'Stripe-style' layouts, an interactive API console, code samples, and can be embedded into any framework or CMS.

## Use cases
- generate api reference docs from an openapi spec
- embed interactive api documentation in a react app
- add api docs to an existing developer portal with web components
- build stripe-style three-column api documentation
- let users try api requests from the docs with an interactive console
- show code samples in curl, python, ruby, java from openapi
- combine markdown guides with api reference documentation
- host api docs statically on s3 or github pages

## When to choose
- you have an OpenAPI (Swagger) 3.x spec and want polished, interactive docs
- you want embeddable React or framework-agnostic Web Components
- you need docs that work in an existing CMS or developer portal
- you want a free, self-hosted, open-source alternative to hosted API doc tools

## When to avoid
- your API is not described by OpenAPI or you need docs for GraphQL/gRPC only
- you need a fully hosted documentation platform with collaboration and governance features
- you need deep customization beyond theming and layout options

## Facets
- artifact type: library
- maturity: active
- function: api-documentation, ui-components, frontend-framework, templating, markdown
- domain: web-development, frontend, apis, documentation, developer-tools
- platform: browser, cross-platform
- tags: openapi, openapi3, web-components, react-components, api-reference, swagger, interactive-docs, developer-portal, web-server, nodejs

## Member repositories
- stoplightio/elements (main) score 67

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:06:53.024370+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T02:30:09.547423+00:00, confidence not recorded.
  - readme: https://github.com/stoplightio/elements (fetched 2026-08-28T04:06:53.024370+00:00, sha 9ed286fc7d4e)
  - homepage: https://stoplight.io/open-source/elements/ (fetched 2026-08-29T10:11:33.695759+00:00, sha c2f8890fb2de)
  - site_page: https://stoplight-site.webflow.io/about (fetched 2026-08-29T10:11:33.707216+00:00, sha 2ed9f2f75d44)
  - site_page: https://stoplight-site.webflow.io/pricing (fetched 2026-08-29T10:11:33.705150+00:00, sha 070c1e91d9e8)
- Data as of 2026-08-30T08:39:29.467469+00:00.