Giter Site home page Giter Site logo
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: [email protected]

Author

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

Material Docs's Projects

material-docs icon material-docs

material-docs - react framework for easy creating documentation site in material design style.

material-docs-documentation icon material-docs-documentation

Documentation for Material Docs. Material Docs - react framework for easy creating documentation site in material design style.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.