leanklass/docz: ✍🏻It has never been so easy to document your things! · GitHub

Thanks for all people that support us 🙏🏻

• 🧘 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.

We still have a long road to go, this is just the beginning. So to further improve docz we've created a roadmap that you can see the next features and improvements. Give us your feedback:

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 in what we are doing 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.

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

• css - Parse css files inside your documents
• babel6 - Use this plugin to use older babel version [DEPRECATED] ⚠️
• netlify - Deploy your documentation to Netlify
• react-native - Allow you to use docz with React Native

• basic - Some basic example
• babel 6 - Using docz with Babel@6 [DEPRECATED] ⚠️
• react native - Using in a React Native project
• 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

• React Spring - Helping react-motion and animated to become best friends
• Smooth UI - Modern React UI library
• Set Protocol Docs - Documentation site of Set Protocal
• Circuit UI - React component library for SumUp web apps
• 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

Due to performance issues docz uses babel 7 and webpack 4. So, if you're using some older version of this packages you'll probably get some errors! About webpack 4 we can't do anything, but about babel, we indicate that you update your babel version. You can do that just by running babel-upgrade:

npx babel-upgrade --write

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

$ 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! 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 Discord server, you have a great team to help you:

Pedro Nauck 💻 📖 🐛 👀	Nicholas Eduardo 💻 📖 🐛	Marcelo Piva 💻 📖 🐛	Guilherme Jabur 💻 📖 🐛