# pedronauck/docz

✍ It has never been so easy to document your things!

Repository: https://github.com/pedronauck/docz
Canonical: https://ross.abutalabs.com/products/docz
Language: TypeScript
License: MIT
License Family: permissive
Topics: docs, documentation, js, react, zero-configuration, ui, design-system, gatsby, mdx, docz, theme
Archived: true
Last push: 2025-11-21T04:28:57+00:00

## Health v2 (maintenance only)
Score: 10/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 53, release rhythm 8, longevity 100
- inputs: {"age_days": 3091, "days_push": 285, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: archived
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 23581, forks 1403 (observed 2026-08-28T04:11:35.100020+00:00)

## What it is
Docz is a zero-configuration documentation tool for JavaScript projects that turns MDX files into live-reloading, production-ready documentation sites. It is built on Gatsby and includes React components like Playground and Props for showcasing interactive component examples.

## Use cases
- document react components with live playgrounds
- build a design system documentation site
- generate a static docs site from mdx files
- show component props tables automatically
- create interactive api documentation for a js library

## When to choose
- you write React components and want interactive MDX-based docs with minimal setup
- you want a Gatsby-based documentation site with theme shadowing for customization
- you need auto-generated props tables from prop-types or TypeScript

## When to avoid
- your project is not React-based
- you need a general-purpose static site generator rather than a docs tool
- you want a tool with heavy active development - consider Storybook or Docusaurus instead

## Facets
- artifact type: library
- maturity: maintenance
- function: documentation, static-site-generator, ui-components, templating
- domain: documentation, web-development, frontend, developer-tools
- platform: cross-platform
- tags: mdx, react, gatsby, design-system, zero-configuration, component-playground, docs-site, nodejs, web-server

## Member repositories
- pedronauck/docz (main) score 10

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:11:35.100020+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-29T16:56:26.570999+00:00, confidence not recorded.
  - readme: https://github.com/pedronauck/docz (fetched 2026-08-28T04:11:35.100020+00:00, sha e6ae00cf38da)
- Data as of 2026-08-30T08:39:29.467469+00:00.