Material Docs - React components API extension
An official extension for the Material Docs documentation framework.
This extension designed to help to create API pages for React components. It includes props and styles tables and other info blocks.
Installation.
With npm:
npm install @material-docs/react-components-docs-extension
With yarn:
yarn add @material-docs/react-components-docs-extension
Usage
<ReactComponentApiPage => <ReactComponentApiPageSummary> <H3>The API documentation of the React component</H3> </ReactComponentApiPageSummary> <ReactComponentApiPageImport> <Code => import Component from "./lib/MyComponent"; import Component from "./lib"; </Code> <Markdown> You can learn more about the difference by reading this guidehttps://...). </Markdown> </ReactComponentApiPageImport> <ReactComponentApiPageProps> <Prop = = =>Children of an element</Prop> <Prop = = =>Your name</Prop> </ReactComponentApiPageProps> <ReactComponentApiPageStyles> <Style = =>Styles applied to the root element</Style> <Style = =>Styles applied to the link element</Style> </ReactComponentApiPageStyles> <ReactComponentApiPageFooter> More information... </ReactComponentApiPageFooter></ReactComponentApiPage>
Support
You can ask for support by email: help.materialdocs@gmail.com
Author
Danil Andreev | danssg08@gmail.com | https://github.com/DanilAndreev