Material Docs

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

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:

• Basics of Material Docs
• Hosting on GitHub Pages
• Localization workflow

Documentation

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

Support

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

Author

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