[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"project-3671":3},{"id":4,"name":5,"fullName":6,"owner":7,"repo":5,"description":8,"homepage":9,"htmlUrl":10,"language":11,"languages":10,"totalLinesOfCode":10,"stars":12,"forks":13,"watchers":12,"openIssues":14,"contributorsCount":15,"subscribersCount":15,"size":15,"stars1d":15,"stars7d":15,"stars30d":15,"stars90d":15,"forks30d":15,"starsTrendScore":15,"compositeScore":16,"rankGlobal":10,"rankLanguage":10,"license":17,"archived":18,"fork":19,"defaultBranch":20,"hasWiki":19,"hasPages":19,"topics":21,"createdAt":10,"pushedAt":10,"updatedAt":32,"readmeContent":33,"aiSummary":34,"trendingCount":15,"starSnapshotCount":15,"syncStatus":35,"lastSyncTime":10,"discoverSource":36},3671,"docz","doczjs\u002Fdocz","doczjs","✍ It has never been so easy to document your things!","",null,"TypeScript",23612,1412,110,0,44.45,"MIT License",true,false,"main",[22,23,24,5,25,26,27,28,29,30,31],"design-system","docs","documentation","gatsby","js","mdx","react","theme","ui","zero-configuration","2026-06-12 02:00:52","# 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:\u002F\u002Fwww.gatsbyjs.org) and [Gatsby theme shadowing](https:\u002F\u002Fwww.gatsbyjs.org\u002Fdocs\u002Fthemes\u002Fshadowing\u002F).\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> **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: \u002F\n---\n\nimport { Playground, Props } from 'docz'\nimport Button from '.\u002FButton'\n\n# Button\n\n\u003CProps of={Button} \u002F>\n\n## Basic usage\n\n\u003CPlayground>\n  \u003CButton type=\"submit\">Click me\u003C\u002FButton>\n  \u003CButton>No, click me\u003C\u002FButton>\n\u003C\u002FPlayground>\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 }) => \u003Cbutton type={type}>{children}\u003C\u002Fbutton>\n\nButton.propTypes = {\n  \u002F**\n   * This is a description for this prop.\n   * Button type.\n   *\u002F\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\u002Fdist\u002F`.\n\nTry it with `yarn docz serve` or by serving the generated site with your favorite static file server (e.g. `npx serve .docz\u002Fdist`).\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\u002Fdist` to copy to the server.\n\n## Examples\n\n- **[with basic](https:\u002F\u002Fgithub.com\u002Fdoczjs\u002Fdocz\u002Ftree\u002Fmain\u002Fexamples\u002Fbasic)**\n- **[with a gatsby site](https:\u002F\u002Fgithub.com\u002Fdoczjs\u002Fdocz\u002Ftree\u002Fmain\u002Fexamples\u002Fgatsby)**\n- **[with react native](https:\u002F\u002Fgithub.com\u002Fdoczjs\u002Fdocz\u002Ftree\u002Fmain\u002Fexamples\u002Freact-native)**\n- **[with styled-components](https:\u002F\u002Fgithub.com\u002Fdoczjs\u002Fdocz\u002Ftree\u002Fmain\u002Fexamples\u002Fstyled-components)**\n- **[with typescript](https:\u002F\u002Fgithub.com\u002Fdoczjs\u002Fdocz\u002Ftree\u002Fmain\u002Fexamples\u002Ftypescript)**\n- **[with algolia search](https:\u002F\u002Fgithub.com\u002Fdoczjs\u002Fdocz\u002Ftree\u002Fmain\u002Fexamples\u002Fwith-algolia-search)**\n- **[with gatsby-remark-vscode](https:\u002F\u002Fgithub.com\u002Fdoczjs\u002Fdocz\u002Ftree\u002Fmain\u002Fexamples\u002Fwith-gatsby-remark-vscode)**\n- **[with react-router](https:\u002F\u002Fgithub.com\u002Fdoczjs\u002Fdocz\u002Ftree\u002Fmain\u002Fexamples\u002Freact-router)**\n- **[with flow](https:\u002F\u002Fgithub.com\u002Fdoczjs\u002Fdocz\u002Ftree\u002Fmain\u002Fexamples\u002Fflow)**\n- **[with images](https:\u002F\u002Fgithub.com\u002Fdoczjs\u002Fdocz\u002Ftree\u002Fmain\u002Fexamples\u002Fimages)**\n- **[with sass](https:\u002F\u002Fgithub.com\u002Fdoczjs\u002Fdocz\u002Ftree\u002Fmain\u002Fexamples\u002Fsass)**\n- **[with less](https:\u002F\u002Fgithub.com\u002Fdoczjs\u002Fdocz\u002Ftree\u002Fmain\u002Fexamples\u002Fless)**\n- **[with stylus](https:\u002F\u002Fgithub.com\u002Fdoczjs\u002Fdocz\u002Ftree\u002Fmain\u002Fexamples\u002Fcss-stylus)**\n- **with css modules**: works out of the box.\n\n### You can check the complete list of docz examples [here](https:\u002F\u002Fgithub.com\u002Fdoczjs\u002Fdocz\u002Ftree\u002Fmain\u002Fexamples).\n\n## Used by\n\n- **[Welcome UI](https:\u002F\u002Fwelcome-ui.com\u002F)**: Customizable design system with react • styled-components • styled-system and reakit.\n- **[React Hooks Testing Library](https:\u002F\u002Freact-hooks-testing-library.com\u002F)**: 🐏 Simple and complete React hooks testing utilities that encourage good testing practices.\n- **[Mobx React](https:\u002F\u002Fmobx-react.js.org\u002F)**: mobx-react documentation site.\n- **[React Google Charts](https:\u002F\u002Freact-google-charts.com\u002F)**: A thin, typed, React wrapper over Google Charts Visualization and Charts API.\n- **[Entur](https:\u002F\u002Fdeveloper.entur.org\u002F)**: Entur operates the national registry for all public transport in Norway.\n- **[FAB Specification](https:\u002F\u002Ffab.dev\u002F)**: 💎 FABs are a compile target for frontend applications.\n- **[@umijs\u002Fhooks](https:\u002F\u002Fhooks.umijs.org\u002F)**: React Hooks Library.\n- **[React Yandex Maps](https:\u002F\u002Freact-yandex-maps.now.sh\u002F)**: Yandex Maps API bindings for React.\n- **[Components-extra](https:\u002F\u002Fcomponents-extra.netlify.com)**: Customizable react component blocks built with material-ui and styled-components.\n- **[Add your site](https:\u002F\u002Fgithub.com\u002Fdoczjs\u002Fdocz\u002Fedit\u002Fmain\u002FREADME.md)**\n\n## Contributors\n\nThis project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].\n\n\u003Ca href=\"https:\u002F\u002Fgithub.com\u002Fdoczjs\u002Fdocz\u002Fgraphs\u002Fcontributors\">\u003Cimg src=\"https:\u002F\u002Fopencollective.com\u002Fdocz\u002Fcontributors.svg?width=890&button=false\" \u002F>\u003C\u002Fa>\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:\u002F\u002Fgithub.com\u002Fdoczjs\u002Fdocz\u002Fissues?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:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fissues\u002Fdoczjs\u002Fdocz\u002Fgood%20first%20issue.svg)](https:\u002F\u002Fgithub.com\u002Fdoczjs\u002Fdocz\u002Fissues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)\n\nRead the [Contributing Guide](\u002FCONTRIBUTING.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\">\n  \u003Ca href=\"https:\u002F\u002Fopencollective.com\u002Fdocz\" target=\"_blank\">\n    \u003Cimg src=\"https:\u002F\u002Fcdn-std.dprcdn.net\u002Ffiles\u002Facc_649651\u002FQ5nVhT\" height=\"80\" alt=\"Open Collective\">\n  \u003C\u002Fa>\n\u003C\u002Fp>\n","Docz 是一个用于编写和发布代码文档的工具。它支持使用 MDX 文件来展示代码，并能将这些文件转换为具有实时重载功能、生产就绪的网站。Docz 通过利用 GatsbyJS 和 Gatsby 主题阴影技术，让用户能够快速创建 SEO 友好且可自定义外观和行为的文档站点。适用于需要高效地为项目生成美观且交互性强的文档的场景，特别适合前端开发者或团队使用。",2,"top_language"]