README.md

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

<ReactComponentApiPage name={"Docs Api page"}>
    <ReactComponentApiPageSummary>
        <H3>The API documentation of the React component.</H3>
    </ReactComponentApiPageSummary>
    <ReactComponentApiPageImport>
        <Code theme={"darcula"}>
            import Component from "./lib/MyComponent";  
            import {Component} from "./lib";
        </Code>
        <Markdown>
            You can learn more about the difference by [reading this guide](https://...).
        </Markdown>
    </ReactComponentApiPageImport>
    <ReactComponentApiPageProps>
        <Prop name={"children"} type={"node"} def={"null"}>Children of an element</Prop>
        <Prop name={"name"} type={"string"} def={"\"\""}>Your name</Prop>
    </ReactComponentApiPageProps>
    <ReactComponentApiPageStyles>
        <Style name={"root"} global={"Mui-root"}>Styles applied to the root element</Style>
        <Style name={"link"} global={"Mui-link"}>Styles applied to the link element</Style>
    </ReactComponentApiPageStyles>
    <ReactComponentApiPageFooter>
        More information...
    </ReactComponentApiPageFooter>
</ReactComponentApiPage>

Explore the docs

Support

You can ask for support by email: [email protected]

Author

Danil Andreev | [email protected] | https://github.com/DanilAndreev