Skip to content
✍🏻It has never been so easy to document your things!
Branch: master
Clone or download
Latest commit d2d181d Mar 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github fix: bug template typo (#197) Aug 6, 2018
.vscode feat(gatsby-theme-docz): add wrapper support Feb 19, 2019
core
examples
other-packages v1.0.0-rc.2 Mar 20, 2019
.all-contributorsrc chore: change readme Jan 23, 2019
.editorconfig
.gitignore chore(docz-core): change package structure Dec 28, 2018
.prettierignore docs: add migration guide and v1 readme changes Feb 25, 2019
.prettierrc chore: remove parser from prettierrc Dec 17, 2018
CHANGELOG.md v1.0.0-rc.3 Mar 21, 2019
CODE_OF_CONDUCT.md
CONTRIBUTING.md fix(docz-theme-default): support absolute page elements (#683) Mar 15, 2019
LICENSE.md
MIGRATION_GUIDE.md
README.md docs: fix readme Mar 23, 2019
lerna.json v1.0.0-rc.3 Mar 21, 2019
package.json v1.0.0-rc.2 Mar 20, 2019
tsconfig.json fix: use custom rollup config to build instead of libundler Dec 29, 2018
tslint.json fix: use custom rollup config to build instead of libundler Dec 29, 2018
yarn.lock

README.md

Open Collective Patreon

Chat

βœ…οΈ Β  Migration Guide

This documentation is for Docz v1. Follow our migration guide if you haven't upgraded your project yet.

🎩   Features

  • 🧘 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 enhanced by the power of components.
  • πŸŽ› Pluggable. Use plugins to manipulate and customise Docz to suit your needs.
  • πŸ” Typescript Support. Full support for TypeScript. Write your type definitions with no extra setup required.

πŸ€” Β  Why?

Libraries that make development easier are appearing every day. Styleguides and design systems are growing in popularity. Today, tools that allow us to get our best work done and be efficient are necessary. We shouldn't be spending too much time on tasks that should be trivial. This is why we created Docz.

Documenting code is one of the most important and time-heavy processes when you're creating something new. A lot of time is wasted on unnecessarily attempting to build a documentation site that will match the style we want.

πŸ‘‰πŸ» Β  More info on our website

πŸŽ› Β  Plugins

πŸ—ƒ Β  Examples

🌍   Around the world

⚠️   Warning

Since the release of v1 you need react and react-dom v16.8.0 or later installed.

πŸ“Ÿ Β  Install and Usage

Getting started with Docz is really quick and easy.

Firstly, install docz and a theme of your choosing using your favourite package manager:

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

# or

$ npm install --save-dev docz@next docz-theme-default@next

Next, add some .mdx files 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>

Finally, run the Docz development server:

$ yarn docz dev

That's it! Now you have some real badass documentation πŸ‘Š

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

🀝   Contributions

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

πŸ’ͺ🏻 Β  Contributors

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

πŸ’­ Β  Needing Help?

If you need some help you can chat with us on our Spectrum Community, we have a great team who would be more than happy to help you:

Pedro Nauck
Pedro Nauck

πŸ’» πŸ“– πŸ› πŸ‘€
You can’t perform that action at this time.