{"id":13400291,"url":"https://github.com/doczjs/docz","last_synced_at":"2025-04-08T00:28:34.426Z","repository":{"id":37444820,"uuid":"125596489","full_name":"doczjs/docz","owner":"doczjs","description":"✍ It has never been so easy to document your things!","archived":false,"fork":false,"pushed_at":"2023-09-30T19:48:39.000Z","size":10072,"stargazers_count":23616,"open_issues_count":110,"forks_count":1455,"subscribers_count":183,"default_branch":"main","last_synced_at":"2024-10-29T22:39:09.252Z","etag":null,"topics":["design-system","docs","documentation","docz","gatsby","js","mdx","react","theme","ui","zero-configuration"],"latest_commit_sha":null,"homepage":"https://docz.site","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/doczjs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":"pedronauck","patreon":"pedronauck","open_collective":"pedronauck"}},"created_at":"2018-03-17T04:24:10.000Z","updated_at":"2024-10-29T05:49:03.000Z","dependencies_parsed_at":"2024-01-16T04:31:39.387Z","dependency_job_id":"a301fb5f-78de-4c50-b85a-07a7356b86b2","html_url":"https://github.com/doczjs/docz","commit_stats":{"total_commits":1574,"total_committers":138,"mean_commits":"11.405797101449275","dds":0.3589580686149937,"last_synced_commit":"91602d1759610b03f3a2a019a1a6269f4ff3d93a"},"previous_names":["pedronauck/docz"],"tags_count":207,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doczjs%2Fdocz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doczjs%2Fdocz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doczjs%2Fdocz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doczjs%2Fdocz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/doczjs","download_url":"https://codeload.github.com/doczjs/docz/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247284957,"owners_count":20913704,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["design-system","docs","documentation","docz","gatsby","js","mdx","react","theme","ui","zero-configuration"],"created_at":"2024-07-30T19:00:50.311Z","updated_at":"2025-04-08T00:28:34.395Z","avatar_url":"https://github.com/doczjs.png","language":"TypeScript","readme":"\u003cp align=\"left\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/docz\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://badgen.net/npm/v/docz\" alt=\"\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"LICENSE.md\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://badgen.net/badge/license/MIT/blue\" alt=\"\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/docz\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://badgen.net/npm/dt/docz\" alt=\"\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003e ⚠️ WARNING\n\n\u003e 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.\n\n\u003e 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.\n\n\u003e 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)!\n\n\u003e Issues related to this old version, also won't be answered, ok? 😅\n\n\u003e Thank you 🙏\n\n# Docz\n\nDocz makes it easy to write and publish beautiful interactive documentation for your code.\nCreate MDX files showcasing your code and Docz turns them into a live-reloading, production-ready site.\n\n## Why?\n\nDocumenting code is one of the most important and time-consuming tasks when developing software.\n\nA lot of time is spent on building and maintaining custom documentation sites.\n\nDocz 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/).\n\n## Getting started\n\nStart by adding `docz` as a dependency to your project with Yarn or npm:\n\n```bash\n$ yarn add docz # react react-dom\n\n# or\n\n$ npm install docz # react react-dom\n```\n\n\u003e **Note**: `react` and `react-dom` will not be installed automatically. You'll have to install them yourself.\n\nThen, create `.mdx` files anywhere in your project:\n\n```mdx\n---\nname: Button\nroute: /\n---\n\nimport { Playground, Props } from 'docz'\nimport Button from './Button'\n\n# Button\n\n\u003cProps of={Button} /\u003e\n\n## Basic usage\n\n\u003cPlayground\u003e\n  \u003cButton type=\"submit\"\u003eClick me\u003c/Button\u003e\n  \u003cButton\u003eNo, click me\u003c/Button\u003e\n\u003c/Playground\u003e\n```\n\nAnd a Button component `Button.jsx`:\n\n```typescript\nimport React from 'react'\nimport t from 'prop-types'\n\nconst Button = ({ children, type }) =\u003e \u003cbutton type={type}\u003e{children}\u003c/button\u003e\n\nButton.propTypes = {\n  /**\n   * This is a description for this prop.\n   * Button type.\n   */\n  type: t.oneOf(['button', 'submit', 'reset']),\n}\nButton.defaultProps = {\n  type: 'button',\n}\nexport default Button\n```\n\nFinally, run:\n\n```bash\nyarn docz dev\n```\n\nThis starts a local development server and opens your documentation site in the browser.\n\n## Build\n\n`yarn docz build` generates a static site in `.docz/dist/`.\n\nTry it with `yarn docz serve` or by serving the generated site with your favorite static file server (e.g. `npx serve .docz/dist`).\n\nYou 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`.\n\n## Deploying\n\nThe output of docz consists of static assets only.\nThis allows you to deploy your generated `docz` site with any static site hosting provider you'd like.\n\nStart 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.\n\n## Examples\n\n- **[with basic](https://github.com/doczjs/docz/tree/main/examples/basic)**\n- **[with a gatsby site](https://github.com/doczjs/docz/tree/main/examples/gatsby)**\n- **[with react native](https://github.com/doczjs/docz/tree/main/examples/react-native)**\n- **[with styled-components](https://github.com/doczjs/docz/tree/main/examples/styled-components)**\n- **[with typescript](https://github.com/doczjs/docz/tree/main/examples/typescript)**\n- **[with algolia search](https://github.com/doczjs/docz/tree/main/examples/with-algolia-search)**\n- **[with gatsby-remark-vscode](https://github.com/doczjs/docz/tree/main/examples/with-gatsby-remark-vscode)**\n- **[with react-router](https://github.com/doczjs/docz/tree/main/examples/react-router)**\n- **[with flow](https://github.com/doczjs/docz/tree/main/examples/flow)**\n- **[with images](https://github.com/doczjs/docz/tree/main/examples/images)**\n- **[with sass](https://github.com/doczjs/docz/tree/main/examples/sass)**\n- **[with less](https://github.com/doczjs/docz/tree/main/examples/less)**\n- **[with stylus](https://github.com/doczjs/docz/tree/main/examples/css-stylus)**\n- **with css modules**: works out of the box.\n\n### You can check the complete list of docz examples [here](https://github.com/doczjs/docz/tree/main/examples).\n\n## More info on [docz.site](https://docz.site)\n\n## Used by\n\n- **[Welcome UI](https://welcome-ui.com/)**: Customizable design system with react • styled-components • styled-system and reakit.\n- **[React Hooks Testing Library](https://react-hooks-testing-library.com/)**: 🐏 Simple and complete React hooks testing utilities that encourage good testing practices.\n- **[Mobx React](https://mobx-react.js.org/)**: mobx-react documentation site.\n- **[React Google Charts](https://react-google-charts.com/)**: A thin, typed, React wrapper over Google Charts Visualization and Charts API.\n- **[Entur](https://developer.entur.org/)**: Entur operates the national registry for all public transport in Norway.\n- **[FAB Specification](https://fab.dev/)**: 💎 FABs are a compile target for frontend applications.\n- **[@umijs/hooks](https://hooks.umijs.org/)**: React Hooks Library.\n- **[React Yandex Maps](https://react-yandex-maps.now.sh/)**: Yandex Maps API bindings for React.\n- **[Components-extra](https://components-extra.netlify.com)**: Customizable react component blocks built with material-ui and styled-components.\n- **[Add your site](https://github.com/doczjs/docz/edit/main/README.md)**\n\n## Contributors\n\nThis project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].\n\n\u003ca href=\"https://github.com/doczjs/docz/graphs/contributors\"\u003e\u003cimg src=\"https://opencollective.com/docz/contributors.svg?width=890\u0026button=false\" /\u003e\u003c/a\u003e\n\n## Contributing\n\nAll kinds of contributions are very welcome and appreciated!\n\nIf you want to contribute time to docz then here's a list of suggestions to get you started:\n\n1. Star the project on GitHub.\n2. 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.\n3. Find and report issues.\n4. Submit pull requests to help solve issues or add features.\n5. Influence the future of docz with feature requests.\n\nIf you're looking for a place to start make sure to check issues tagged with the `good first issue` label:\n\n[![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)\n\nRead the [Contributing Guide](/CONTRIBUTING.md) before you open a pull request.\n\nYou can also sponsor us via OpenCollective to help secure docz's future.\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://opencollective.com/docz\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://cdn-std.dprcdn.net/files/acc_649651/Q5nVhT\" height=\"80\" alt=\"Open Collective\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n","funding_links":["https://github.com/sponsors/pedronauck","https://patreon.com/pedronauck","https://opencollective.com/pedronauck","https://opencollective.com/docz"],"categories":["Uncategorized","TypeScript","Documentation Tools","Docs","前端开发框架及项目","Tools","文档工具","documentation","ui",":file_folder:Efficiency","React [🔝](#readme)","Built on remark","Documentation Types"],"sub_categories":["Uncategorized","其他_文本生成、文本对话","Docz","Doc Tools","Code Documentation"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoczjs%2Fdocz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdoczjs%2Fdocz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoczjs%2Fdocz/lists"}