https://github.com/material-docs/react-components-docs-extension
Material Docs framework extension for creating React components API pages.
https://github.com/material-docs/react-components-docs-extension
api components extension material-design material-docs material-ui react reactjs
Last synced: 8 months ago
JSON representation
Material Docs framework extension for creating React components API pages.
- Host: GitHub
- URL: https://github.com/material-docs/react-components-docs-extension
- Owner: material-docs
- License: mit
- Archived: true
- Created: 2020-09-18T18:52:55.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-09-23T09:07:33.000Z (over 5 years ago)
- Last Synced: 2024-05-02T09:21:46.997Z (about 2 years ago)
- Topics: api, components, extension, material-design, material-docs, material-ui, react, reactjs
- Language: JavaScript
- Homepage: https://material-docs.com
- Size: 895 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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
```
[Read installation guide]()
## Usage
```jsx
The API documentation of the React component.
import Component from "./lib/MyComponent";
import {Component} from "./lib";
You can learn more about the difference by [reading this guide](https://...).
Children of an element
Your name
Styles applied to the root element
Styles applied to the link element
More information...
```
[Explore the docs]()
## Support
You can ask for support by email: help.materialdocs@gmail.com
## Author
Danil Andreev | danssg08@gmail.com | https://github.com/DanilAndreev