Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/doczjs/docz

✍ It has never been so easy to document your things!
https://github.com/doczjs/docz

design-system docs documentation docz gatsby js mdx react theme ui zero-configuration

Last synced: 11 days ago
JSON representation

✍ It has never been so easy to document your things!

Awesome Lists containing this project

README 

        


  

    

  

  

    

  

  

    

  




> ⚠️ WARNING



> This is an **OUTDATED** version of Docz, if you are going to use it, be aware that you may possibly find bugs due to the outdated dependencies. Mainly because of all this time without updates, became almost impossible to follow with the decision of keep the same stack and update things.



> So, we're working in a [new version](https://github.com/doczjs/docz/tree/new) that will include an entire core refactoring/rewritting by adding [Astro](https://astro.build) behind the scenes as bundler and another cools feature.



> Since we really want to don't have so much breakings changes - and try to bring back the spot and quality Docz deserves - this can take a while to be done, please be patient and if you want to help, just send me a message [on my Twitter](https://twitter.com/pedronauck)!



> Issues related to this old version, also won't be answered, ok? 😅



> Thank you 🙏



# Docz



Docz makes it easy to write and publish beautiful interactive documentation for your code.

Create MDX files showcasing your code and Docz turns them into a live-reloading, production-ready site.



## Why?



Documenting code is one of the most important and time-consuming tasks when developing software.



A lot of time is spent on building and maintaining custom documentation sites.



Docz enables you to quickly create a live-reloading, SEO-friendly, production-ready documentation site with MDX and customize the look, feel and behavior when required by leveraging [GatsbyJS](https://www.gatsbyjs.org) and [Gatsby theme shadowing](https://www.gatsbyjs.org/docs/themes/shadowing/).



## Getting started



Start by adding `docz` as a dependency to your project with Yarn or npm:



```bash

$ yarn add docz # react react-dom



# or



$ npm install docz # react react-dom

```



> **Note**: `react` and `react-dom` will not be installed automatically. You'll have to install them yourself.



Then, create `.mdx` files anywhere in your project:



```mdx

---

name: Button

route: /

---



import { Playground, Props } from 'docz'

import Button from './Button'



# Button



## Basic usage



  Click me

  No, click me



```



And a Button component `Button.jsx`:



```typescript

import React from 'react'

import t from 'prop-types'



const Button = ({ children, type }) => {children}



Button.propTypes = {

  /**

   * This is a description for this prop.

   * Button type.

   */

  type: t.oneOf(['button', 'submit', 'reset']),

}

Button.defaultProps = {

  type: 'button',

}

export default Button

```



Finally, run:



```bash

yarn docz dev

```



This starts a local development server and opens your documentation site in the browser.



## Build



`yarn docz build` generates a static site in `.docz/dist/`.



Try it with `yarn docz serve` or by serving the generated site with your favorite static file server (e.g. `npx serve .docz/dist`).



You can have `yarn docz build` emit to a different directory by providing a path to the `dest` field in your `doczrc.js` or from the command line: `yarn docz build --dest docs-site-directory`.



## Deploying



The output of docz consists of static assets only.

This allows you to deploy your generated `docz` site with any static site hosting provider you'd like.



Start by building your site with `yarn docz build`, if you haven't provided a `dest` flag to your config then you will find your generated files in `.docz/dist` to copy to the server.



## Examples



- **[with basic](https://github.com/doczjs/docz/tree/main/examples/basic)**

- **[with a gatsby site](https://github.com/doczjs/docz/tree/main/examples/gatsby)**

- **[with react native](https://github.com/doczjs/docz/tree/main/examples/react-native)**

- **[with styled-components](https://github.com/doczjs/docz/tree/main/examples/styled-components)**

- **[with typescript](https://github.com/doczjs/docz/tree/main/examples/typescript)**

- **[with algolia search](https://github.com/doczjs/docz/tree/main/examples/with-algolia-search)**

- **[with gatsby-remark-vscode](https://github.com/doczjs/docz/tree/main/examples/with-gatsby-remark-vscode)**

- **[with react-router](https://github.com/doczjs/docz/tree/main/examples/react-router)**

- **[with flow](https://github.com/doczjs/docz/tree/main/examples/flow)**

- **[with images](https://github.com/doczjs/docz/tree/main/examples/images)**

- **[with sass](https://github.com/doczjs/docz/tree/main/examples/sass)**

- **[with less](https://github.com/doczjs/docz/tree/main/examples/less)**

- **[with stylus](https://github.com/doczjs/docz/tree/main/examples/css-stylus)**

- **with css modules**: works out of the box.



### You can check the complete list of docz examples [here](https://github.com/doczjs/docz/tree/main/examples).



## More info on [docz.site](https://docz.site)



## Used by



- **[Welcome UI](https://welcome-ui.com/)**: Customizable design system with react • styled-components • styled-system and reakit.

- **[React Hooks Testing Library](https://react-hooks-testing-library.com/)**: 🐏 Simple and complete React hooks testing utilities that encourage good testing practices.

- **[Mobx React](https://mobx-react.js.org/)**: mobx-react documentation site.

- **[React Google Charts](https://react-google-charts.com/)**: A thin, typed, React wrapper over Google Charts Visualization and Charts API.

- **[Entur](https://developer.entur.org/)**: Entur operates the national registry for all public transport in Norway.

- **[FAB Specification](https://fab.dev/)**: 💎 FABs are a compile target for frontend applications.

- **[@umijs/hooks](https://hooks.umijs.org/)**: React Hooks Library.

- **[React Yandex Maps](https://react-yandex-maps.now.sh/)**: Yandex Maps API bindings for React.

- **[Components-extra](https://components-extra.netlify.com)**: Customizable react component blocks built with material-ui and styled-components.

- **[Add your site](https://github.com/doczjs/docz/edit/main/README.md)**



## Contributors



This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].






## Contributing



All kinds of contributions are very welcome and appreciated!



If you want to contribute time to docz then here's a list of suggestions to get you started:



1. Star the project on GitHub.

2. Help people in the [issues](https://github.com/doczjs/docz/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) by sharing your knowledge and experience.

3. Find and report issues.

4. Submit pull requests to help solve issues or add features.

5. Influence the future of docz with feature requests.



If you're looking for a place to start make sure to check issues tagged with the `good first issue` label:



[![Good First Issue](https://img.shields.io/github/issues/doczjs/docz/good%20first%20issue.svg)](https://github.com/doczjs/docz/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)



Read the [Contributing Guide](/CONTRIBUTING.md) before you open a pull request.



You can also sponsor us via OpenCollective to help secure docz's future.





  

    Open Collective