GitHub - pedronauck/docz: ✍?It has never been so easy to document your things!

README.md

Home | Introduction | Documentation | Themes | Plugins

?   Features

• ? Zero config and easy. Don't worry about complex configurations steps.
• ⚡️Blazing Fast. Full hot reload support with Wepack 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.

?   Why?

The open source world with tools that make developer's life easier, the creation of styleguides and design system are growing and evolving so fast. New and impressive things arising every day. Tools that allow us to evolve together are really necessary nowadays. We can't create barriers or lose time with tasks that should be trivial for us.

To break barriers and facilitating the creation of tools that's Docz arose. Document our things is one of the most important and painful processes that exist when you're creating something new. We lose a lot of our precious time with unnecessary setups to can build something that can represent and express what we want with our own style.

?   About

• Introduction
  • Getting Started
  • Writing MDX
  • Documenting your Things
  • Customizing
  • Deploying your docs
• Documentation
  • Project Configuration
  • Components API
  • Creating Themes
  • CreatingPlugins
• Themes
• Plugins

?   Install and Usage

Simplicity is one of our core principles. So, getting started with docz is something really easy and quick. First of all, you need to install docz on your project using some package manager

$ yarn add docz --dev

Then create some .mdx anywhere inside your project:

---
name: Button
---

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

#Button

<PropsTable 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! You have a real badass documentation now ?

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

?   Contributions

Contributions, issues and feature requests are very welcome. If you are using this package and fixed a bug for yourself, please consider submitting a PR! Also you can ping me at Twitter