Skip to content
Get packs

Docz

Turns MDX files into a live-reloading documentation website for your code.

GitHub Download v2.4.0
Stars
23.6k
Forks
1.4k
Licence
MIT
Language
TypeScript
Last update
12 months ago
Type
Dev tool

This repository is archived and no longer maintained.

What it is

Docz is a tool that lets developers write documentation as MDX files, which mix Markdown with React components, and turns them into a documentation website. It runs a local preview that reloads as you edit, and can build a static site that you host anywhere. It is built on GatsbyJS, so it is aimed mainly at React projects.

  • Write a Markdown page that shows a live, interactive example of a component using the Playground block
  • Generate a component props table from a React component with the Props block
  • Build a static documentation site into .docz/dist and deploy it to a static host
  • Run a local development server while you write docs

Great for

  • React developers who want a documentation site for a component library
  • Teams that want docs next to their code without building a custom docs site
  • Developers who want live examples embedded in their documentation
  • Projects that need a static site they can host on any static host

Not ideal for

  • Projects that are not based on React, since the README focuses on React components
  • People who need an actively maintained tool, because the repository is archived and its last push was in November 2025
  • Anyone who needs a simple Markdown-only docs site with no React, since Docz depends on MDX and GatsbyJS

How to get it

  1. 1

    Install with a package manager

    You'll need: Node.js · Yarn or npm · React and react-dom

    Add docz to your project with Yarn

    yarn add docz # react react-dom

    Or add docz with npm

    npm install docz # react react-dom

    Start the local development server

    yarn docz dev

    Build the static site

    yarn docz build
  2. 2

    Run it

    • Install docz and react and react-dom in your project
    • Create a .mdx file anywhere in your project with a name and route in its front matter
    • Run yarn docz dev to start the local server and open the site in your browser
    • Run yarn docz build to generate a static site in .docz/dist
  3. 3

    Get the most out of it

    • Use the Props block with your component to generate an API table automatically
    • Use the Playground block to show interactive examples next to the explanation text
    • Set the dest field in doczrc.js or use --dest on the command line to change the build output folder
    • Check the examples folder in the repository, which includes Sass, Less, Stylus, styled-components, TypeScript and Algolia search setups

Downloads

Source code (.zip)main branch · straight from GitHubRelease v2.4.0Release notes and source

Strengths

  • Setup is short: add the package, write MDX files, and run one dev command
  • Produces static files only, so hosting is simple and flexible
  • Lets you embed live React examples in the docs

Trade-offs

  • The repository is archived, so it is unlikely to receive fixes or new features
  • Depends on GatsbyJS, which adds a heavy build toolchain
  • Requires react and react-dom to be installed separately

How it compares

ProjectStarsTypeLevelUpdatedBest for
docz (this)23.6kDev toolintermediate12 months agoReact developers who want a documentation site for a component library
storybook91.4kDev toolintermediate4 days agoFrontend teams building a shared component library or design system
docusaurus66.6kFrameworkintermediate4 days agoOpen source projects that need a documentation website
vitepress18.5kDev toolintermediate8 days agoDevelopers who want a documentation site for a software project
docsify31.6kDev toolbeginner4 days agoOpen-source maintainers who want a documentation site from existing Markdown files
mdx-deck11.5kDev toolintermediate3.8 years agoDevelopers who already write React and want to present technical material

Stats synced from GitHub. The assessment above was drafted with AI from the project's README on 2026-10-29 and may miss recent changes — check the README before relying on a command. MIT licence: free to use, modify and distribute, including commercially, as long as you keep the copyright notice.