Skip to content
This repository was archived by the owner on Nov 16, 2022. It is now read-only.

Commit 187721b

Browse files
committed
[readme] Added Material Docs readme.
1 parent 81dca98 commit 187721b

File tree

1 file changed

+50
-68
lines changed

1 file changed

+50
-68
lines changed

Diff for: README.md

+50-68
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,50 @@
1-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
2-
3-
## Available Scripts
4-
5-
In the project directory, you can run:
6-
7-
### `yarn start`
8-
9-
Runs the app in the development mode.<br />
10-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
11-
12-
The page will reload if you make edits.<br />
13-
You will also see any lint errors in the console.
14-
15-
### `yarn test`
16-
17-
Launches the test runner in the interactive watch mode.<br />
18-
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
19-
20-
### `yarn build`
21-
22-
Builds the app for production to the `build` folder.<br />
23-
It correctly bundles React in production mode and optimizes the build for the best performance.
24-
25-
The build is minified and the filenames include the hashes.<br />
26-
Your app is ready to be deployed!
27-
28-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
29-
30-
### `yarn eject`
31-
32-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
33-
34-
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
35-
36-
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
37-
38-
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
39-
40-
## Learn More
41-
42-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
43-
44-
To learn React, check out the [React documentation](https://reactjs.org/).
45-
46-
### Code Splitting
47-
48-
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
49-
50-
### Analyzing the Bundle Size
51-
52-
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
53-
54-
### Making a Progressive Web App
55-
56-
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
57-
58-
### Advanced Configuration
59-
60-
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
61-
62-
### Deployment
63-
64-
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
65-
66-
### `yarn build` fails to minify
67-
68-
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
1+
<div align="center">
2+
<img alt="Material Docs logo" src="https://github.com/DanilAndreev/material-docs/blob/master/images/MaterialDocsLogoOverview.png"/>
3+
</div>
4+
<div align="center">
5+
</div>
6+
7+
# Material Docs
8+
### React framework for easy creating documentation site in material design style
9+
## Installation.
10+
With __npm__:
11+
```
12+
npm install @danilandreev/material-docs
13+
```
14+
With __yarn__:
15+
```
16+
yarn add @danilandreev/material-docs
17+
```
18+
[Read installation guide]()
19+
## Usage
20+
```jsx
21+
import React from "react";
22+
import DocsLayout from "@danilandreev/material-docs/layout/DocsLayout";
23+
import DocsPages from "@danilandreev/material-docs/components/DocsPages";
24+
import PagesGroup from "@danilandreev/material-docs/components/PagesGroup/PagesGroup";
25+
26+
27+
export default function MyApp() {
28+
return(
29+
<DocsLayout autoMenu>
30+
<DocsPages>
31+
<PagesGroup name={"Getting started"}>
32+
33+
</PagesGroup>
34+
<PagesGroup name={"Components"}>
35+
<DocsPageDemo... />
36+
</PagesGroup>
37+
<PagesGroup name={"APIs"}>
38+
<DocsPageAPI... />
39+
</PagesGroup>
40+
</DocsPages>
41+
</DocsLayout>
42+
);
43+
}
44+
```
45+
[Explore the docs]()
46+
## Support
47+
You can ask for support by email: [email protected]
48+
49+
## Author
50+
Danil Andreev | [email protected] | https://github.com/DanilAndreev

0 commit comments

Comments
 (0)