Glazy/docz

This documentation it's about v1. If you need to migrate your project, please read our Migration Guide

• 🧘 Zero config and easy. Don't worry about complex configurations steps.
• ⚡️ Blazing Fast. Full hot reload support with webpack 4 and automatic code splitting.
• 💅 Easy to customize. Create and use real customizable themes.
• 📝 MDX Based. Write markdown with all power of components.
• 🎛 Pluggable. With plugins, you can manipulate a lot of things through the docz flow and data.
• 🔐 Typescript Support. We have a full support for your type definitions.

Libraries that make our life easier coming up every day. Styleguides and design system are growing so fast. Today, tools that allow us to be quick and effective are really necessary. We can't lose time with tasks that should be trivial for us. Thinking about that docz came out.

Documenting our things is one of the most important and heavy processes when you're creating something new. We waste a lot of time with unnecessary setups to build something that can represent and we want with our own style.

• gatsby-theme-docz - Use docz as a theme for Gatsby
• css - Parse css files inside your documents
• netlify - Deploy your documentation to Netlify
• postcss - Use Docz with PostCSS
• svg sprite loader - Docz plugin for SVG sprite loader
• snapshots - A plugin for docz that creates jest snapshots for all documented component usages

• basic - Some basic example
• gatsby - Example using Docz as a theme for Gatsby
• react native - Using in a React Native project
• styled-components - Using docz with styled-components
• with typescript - Using docz with Typescript
• with flow - Using docz with Flow
• with sass - Using docz parsing css with Sass
• with less - Using docz parsing css with Less
• with postcss - Using docz parsing css with PostCSS
• with stylus - Using docz parsing css with Stylus

• Smooth UI - Modern React UI library
• Set Protocol Docs - Documentation site of Set Protocal
• RBX - The Comprehensive Bulma UI Framework for React
• Circuit UI - React component library for SumUp web apps
• Fannypack - A friendly & accessible React UI Kit built with Reakit
• React Pixi - React Fiber renderer for Pixi
• React Hotkey Tooltip - A global Hotkey provider with built in tooltip for React
• Sajari React SDK - Library of React Components for the Sajari

Since our new v1, you need react and react-dom with >= 16.8.0 installed.

Getting started with docz is something really easy and quick. First of all, you will need to install docz and some theme on your project using your favorite package manager (we'll asume yarn for this example):

$ yarn add docz@next docz-theme-default@next --dev

Then create some .mdx anywhere inside your project:

---
name: Button
---

import { Playground, Props } from 'docz'
import Button from './'

# Button

<Props of={Button} />

## Basic usage

<Playground>
  <Button>Click me</Button>
  <Button kind="secondary">Click me</Button>
</Playground>

Now, just run your dev server:

$ yarn docz dev

That's it! Now you have a real badass documentation 👊

Any doubt? Check our docs to see more about docz!

Contributions, issues and feature requests are very welcome. Please make sure to read the Contributing Guide before making a pull request.

This project exists thanks to all the people who contribute. [Contribute].

If you need some help you can chat with us on our Spectrum Community, you have a great team to help you:

Pedro Nauck 💻 📖 🐛 👀