{"id":15069990,"url":"https://github.com/material-docs/react-components-docs-extension","last_synced_at":"2025-10-05T06:31:33.068Z","repository":{"id":124557482,"uuid":"296705339","full_name":"material-docs/react-components-docs-extension","owner":"material-docs","description":"Material Docs framework extension for creating React components API pages.","archived":true,"fork":false,"pushed_at":"2020-09-23T09:07:33.000Z","size":916,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-05-02T09:21:46.997Z","etag":null,"topics":["api","components","extension","material-design","material-docs","material-ui","react","reactjs"],"latest_commit_sha":null,"homepage":"https://material-docs.com","language":"JavaScript","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/material-docs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-09-18T18:52:55.000Z","updated_at":"2022-11-16T09:05:24.000Z","dependencies_parsed_at":"2023-06-07T21:45:20.991Z","dependency_job_id":null,"html_url":"https://github.com/material-docs/react-components-docs-extension","commit_stats":{"total_commits":28,"total_committers":1,"mean_commits":28.0,"dds":0.0,"last_synced_commit":"b645325d7538f678e6eff42522a86b17882d2771"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/material-docs%2Freact-components-docs-extension","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/material-docs%2Freact-components-docs-extension/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/material-docs%2Freact-components-docs-extension/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/material-docs%2Freact-components-docs-extension/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/material-docs","download_url":"https://codeload.github.com/material-docs/react-components-docs-extension/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235370461,"owners_count":18979093,"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":["api","components","extension","material-design","material-docs","material-ui","react","reactjs"],"created_at":"2024-09-25T01:46:15.262Z","updated_at":"2025-10-05T06:31:32.695Z","avatar_url":"https://github.com/material-docs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \u003cimg alt=\"Material Docs logo\" src=\"https://github.com/DanilAndreev/material-docs/blob/master/images/MaterialDocsLogoOverview.png\"/\u003e\n\u003c/div\u003e\n\u003cdiv align=\"center\"\u003e\n\u003c/div\u003e\n\n# Material Docs - React components API extension\n### An official extension for the Material Docs documentation framework.\nThis _extension_ designed to help to create API pages for ___React___ components. It includes __props__ and __styles__ tables and other info blocks. \n## Installation.\nWith __npm__:  \n```\nnpm install @material-docs/react-components-docs-extension\n```\nWith __yarn__:  \n```\nyarn add @material-docs/react-components-docs-extension\n```\n[Read installation guide]()\n## Usage\n```jsx\n\u003cReactComponentApiPage name={\"Docs Api page\"}\u003e\n    \u003cReactComponentApiPageSummary\u003e\n        \u003cH3\u003eThe API documentation of the React component.\u003c/H3\u003e\n    \u003c/ReactComponentApiPageSummary\u003e\n    \u003cReactComponentApiPageImport\u003e\n        \u003cCode theme={\"darcula\"}\u003e\n            import Component from \"./lib/MyComponent\";  \n            import {Component} from \"./lib\";\n        \u003c/Code\u003e\n        \u003cMarkdown\u003e\n            You can learn more about the difference by [reading this guide](https://...).\n        \u003c/Markdown\u003e\n    \u003c/ReactComponentApiPageImport\u003e\n    \u003cReactComponentApiPageProps\u003e\n        \u003cProp name={\"children\"} type={\"node\"} def={\"null\"}\u003eChildren of an element\u003c/Prop\u003e\n        \u003cProp name={\"name\"} type={\"string\"} def={\"\\\"\\\"\"}\u003eYour name\u003c/Prop\u003e\n    \u003c/ReactComponentApiPageProps\u003e\n    \u003cReactComponentApiPageStyles\u003e\n        \u003cStyle name={\"root\"} global={\"Mui-root\"}\u003eStyles applied to the root element\u003c/Style\u003e\n        \u003cStyle name={\"link\"} global={\"Mui-link\"}\u003eStyles applied to the link element\u003c/Style\u003e\n    \u003c/ReactComponentApiPageStyles\u003e\n    \u003cReactComponentApiPageFooter\u003e\n        More information...\n    \u003c/ReactComponentApiPageFooter\u003e\n\u003c/ReactComponentApiPage\u003e\n```\n[Explore the docs]()\n## Support\nYou can ask for support by email: help.materialdocs@gmail.com\n\n## Author\nDanil Andreev | danssg08@gmail.com | https://github.com/DanilAndreev\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaterial-docs%2Freact-components-docs-extension","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaterial-docs%2Freact-components-docs-extension","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaterial-docs%2Freact-components-docs-extension/lists"}