Wondering what’s next for npm?Check out our public roadmap! »

    @material-docs/core
    TypeScript icon, indicating that this package has built-in type declarations

    0.6.6 • Public • Published
    Material Docs logo

    Material Docs

    A React framework for easy creating documentation site in material design style

    GitHub package.json version GitHub forks GitHub Repo stars GitHub pull requests GitHub top language npm GitHub issues

    Overview

    Material Docs is a React framework for material design style documentation. It allows easy page manipulation, has a built-in localization and search engine. Fully compatible with Markdown markup language.

    Compatible with GitHub Pages and other hosts!

    Installation.

    With npm:

    npm install @material-docs/core
    

    With yarn:

    yarn add @material-docs/core
    

    Read installation guide

    Usage

    import React from "react";
    import DocsLayout from "@material-docs/core/layout/DocsLayout";
    import DocsPages from "@material-docs/core/components/DocsPages";
    import DocsMenu from "@material-docs/core/components/DocsMenu";
    import AutoDocsMenu from "@material-docs/core/components/AutoDocsMenu";
    import DocsPage from "@material-docs/core/components/PagesGroup/DocsPage";
    import PagesGroup from "@material-docs/core/components/PagesGroup/PagesGroup";
     
     
    export default function MyApp() {
        return(
            <DocsLayout>
                <DocsMenu>
                    <AutoDocsMenu/>
                </DocsMenu>
                <DocsPages>
                    <PagesGroup name="Getting started">
                        {/*...*/}
                    </PagesGroup>
                    <PagesGroup name="Components">
                        <DocsPage
                            name="My page"
                            searchDescription="This is a page inside my documentation"
                        >
                            {/*...*/}
                        </DocsPage>
                    </PagesGroup>
                    <PagesGroup name="APIs">
                        {/*...*/}
                    </PagesGroup>
                </DocsPages>
            </DocsLayout>
        );
    }

    Learn

    Tutorials

    You can learn Material Docs on practice with tutorials:

    Documentation

    If you want to get specifications and other info - visit Material Docs Documentation

    Support

    You can ask for support by email: help.materialdocs@gmail.com

    Author

    Danil Andreev | danssg08@gmail.com | https://github.com/DanilAndreev

    Install

    npm i @material-docs/core

    DownloadsWeekly Downloads

    4

    Version

    0.6.6

    License

    CC0-1.0

    Unpacked Size

    572 kB

    Total Files

    354

    Last publish

    Collaborators

    • avatar