https://github.com/matmalkowski/docz-knobs

🎛 Knobs component to demo your React creations with Docz
https://github.com/matmalkowski/docz-knobs

documentation docz docz-plugin knobs mdx react

Last synced: 13 days ago
JSON representation

🎛 Knobs component to demo your React creations with Docz

• Host: GitHub
• URL: https://github.com/matmalkowski/docz-knobs
• Owner: matmalkowski
• Created: 2019-03-28T16:27:27.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T17:16:59.000Z (over 2 years ago)
• Last Synced: 2025-04-18T16:38:06.282Z (26 days ago)
• Topics: documentation, docz, docz-plugin, knobs, mdx, react
• Language: TypeScript
• Homepage:
• Size: 1.38 MB
• Stars: 4
• Watchers: 0
• Forks: 3
• Open Issues: 38
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![NPM](https://img.shields.io/npm/v/docz-knobs.svg)](https://www.npmjs.com/package/docz-knobs)

[![build](https://travis-ci.org/matmalkowski/docz-knobs.svg?branch=master)](https://travis-ci.org/matmalkowski/docz-)

# 🎛 docz-knobs

> Knobs component set to use with your docz based documents!

[Docz](https://www.docz.site/) is a great `MDX` based framework for documenting your libraries and projects. With this simple `Knobs` component it enables even more features as in renders helper knobs/switches for your component to make the demo even more rebust and accessible! is a

## 🛠 Install

```bash

yarn add docz-knobs

npm install --save docz-knobs

```

## 📟 Usage

Simply wrap your component in MDX file with the `Knobs` component.

```tsx

import * as React from "react";

import Knobs from "docz-knobs";

import { Button } from "./Button";

  Click me

;

```

![Example Image](https://i.imgur.com/yrAUDKC.png)

For complex types you need to specify available values with options prop.

## License

MIT © [matmalkowski](https://github.com/matmalkowski)