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

Commit 4c1637d

Browse files
DanilAndreevDanilAndreev
authored
Merge pull request #22 from material-docs/prod
Material Docs 0.2.0
2 parents 3f63bd3 + e017c52 commit 4c1637d

File tree

10 files changed

+135
-10
lines changed

10 files changed

+135
-10
lines changed

‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@material-docs/material-docs-documentation",
3-
"version": "0.1.9",
3+
"version": "0.2.0",
44
"private": false,
55
"description": "Documentation for Material Docs. material-docs - react framework for easy creating documentation site in material design style.",
66
"homepage": "http://material-docs.com/",

‎src/Documentation.js

+2
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ import LandingAPI from "./pages/APIs/LandingAPI";
7474
import LinkAPI from "./pages/APIs/LinkAPI";
7575
import HostingMaterialDocsOnGHPages from "./pages/Tutorials/HostingMaterialDocsOnGHPages";
7676
import AdvancedMaterialDocsUsage from "./pages/Tutorials/LocalizationWorkflow";
77+
import Introduction from "./pages/GettingStarted/Introduction";
7778

7879

7980
export default function Documentation() {
@@ -113,6 +114,7 @@ export default function Documentation() {
113114
</Landing>
114115
<DocsPages>
115116
<PagesGroup name={"Getting started"} order={1}>
117+
<Introduction/>
116118
<Installation/>
117119
</PagesGroup>
118120
<PagesGroup name={"Tutorials"} order={2}>

‎src/locale/EN.json

+24
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,30 @@
33
"label": "English",
44
"locale": {
55
"pages": {
6+
"IntroductionPage": {
7+
"headers": {
8+
"introduction": "Introduction",
9+
"what": "What is Material Docs",
10+
"why": "Why Material Docs",
11+
"mui": "A little about Material UI",
12+
"docs": "Documentation"
13+
},
14+
"what": "__Material Docs__ is a Material Design-style documentation framework based on React. With Material Docs, you can easily create documentation pages without bothering with the table of contents, customization of paths, customization of search and complex customization of localization.",
15+
"why1": "Material Docs has a built-in localization, search and basic markup system. ",
16+
"why2": "Out of the box, you immediately get a large set of visual components for decorating content. ",
17+
"why3": "All Material Docs components work well with each other and have __built-in theming__.",
18+
"why4": "System of __automatic menu generation__, based on page settings.",
19+
"why5": "Deep markdown support. You can create different __components of material Docs__ with __markdown__!",
20+
"why6": "Built-in dark and light theme.",
21+
"why7": "The ability to expand the system. Material Docs includes tools that allow you to __create extensions__ and customize the system in general.",
22+
"mui": "__Material Docs__ is based on the __Material UI__ visual component library. We recommend using it to create\ncustom extensions, though, you can use other libraries as well.",
23+
"docs": "The documentation is divided into sections:",
24+
"docsPart1": "information for a quick start.",
25+
"docsPart2": "detailed lessons on different approaches to creating Material Docs.",
26+
"docsPart3": "Material Docs component demo pages.",
27+
"docsPart4": "api documentation for each of the components.",
28+
"docsPart5": "documentation of official additions to Material Docs."
29+
},
630
"LocalizationWorkflowTutorial": {
731
"headers": {
832
"localizationProcess": "Localization process",

‎src/locale/RU.json

+24
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,30 @@
33
"label": "Русский",
44
"locale": {
55
"pages": {
6+
"IntroductionPage": {
7+
"headers": {
8+
"introduction": "Введение",
9+
"what": "Что такое Material Docs",
10+
"why": "Почему именно Material Docs",
11+
"mui": "Немного о Material UI",
12+
"docs": "Документация"
13+
},
14+
"what": "__Material Docs__ - это фреймворк для создания документации в стилистике Material Design, основанный на React. \nС помощью Material Docs вы можете легко создавать страницы с документацией и не заморачиваться над оглавлением, \nнастройкой путей, настройкой поиска и сложной настройкой локализации.",
15+
"why1": "Material Docs имеет встроенную систему локализации, поиска и базовой разметки. ",
16+
"why2": "Из коробки вы сразу получаете большой набор визуальных компонентов для оформления содержания. ",
17+
"why3": "Все компоненты Material Docs отлично сочетаются друг с другом и имеют __встроенную темизацию__.",
18+
"why4": "Система __автоматической генерации меню__, на основе настроек страниц.",
19+
"why5": "Глубокая поддержка markdown. Вы можете создавать разные __компоненты material Docs__ при помощи __markdown__!",
20+
"why6": "Встроенные темная и светлая тема.",
21+
"why7": "Возможность расширить систему. Material Docs включает в себя инструменты, которые позволят __создавать расширения__ и настраивать систему в общем.",
22+
"mui": "__Material Docs__ основана на библиотеке визуальных компонентов __Material UI__. Мы рекомендуем использовать ее для создания \nпользовательских расширений, хотя, вы можете использовать и другие библиотеки.",
23+
"docs": "Документация разделена на разделы:",
24+
"docsPart1": "информация для быстрого старта.",
25+
"docsPart2": "подробно расписанные уроки по разным подходам создания Material Docs. ",
26+
"docsPart3": "демонстрационные страницы компонентов Material Docs.",
27+
"docsPart4": "api документация по каждому из компонентов.",
28+
"docsPart5": "документация официальных дополнений к Material Docs."
29+
},
630
"LocalizationWorkflowTutorial": {
731
"headers": {
832
"localizationProcess": "Процесс локализации",

‎src/pages/GettingStarted/Installation/index.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ export default function Installation() {
4444
searchDescription={"Installation page for MaterialDocs."}
4545
searchLabel={"Installation"}
4646
searchTags={["installation", "getting", "started"]}
47+
order={2}
4748
>
4849
<H1>Installation</H1>
4950
<H3 noTag noDivider>Install MaterialDocs - framework for creating documentation.</H3>
@@ -62,7 +63,7 @@ export default function Installation() {
6263
<H2>Info</H2>
6364
<Markdown>You can start using MaterialDocs with minimal front-end infrastructure. Package providing a lot of
6465
components to create great documentation site.</Markdown>
65-
<H4>Some steps tu get started</H4>
66+
<H4>Some steps to get started</H4>
6667
<List>
6768
<ListItem>Read <Bold>Components</Bold> tab and get access to demonstration source code.</ListItem>
6869
<ListItem>Read <Bold>Component APIs</Bold> tab and get to know how to manipulate with

‎src/pages/GettingStarted/Introduction/images/MaterialDocsLogoOverview.svg

+1
Loading

‎src/pages/GettingStarted/Introduction/index.js

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
/*
2+
* Author: Andrieiev Danil | [email protected] | https://github.com/DanilAndreev
3+
* Copyright (C) 2020.
4+
*/
5+
6+
import React from "react";
7+
import DocsPage from "@material-docs/core/components/DocsPage/DocsPage";
8+
import Markdown from "@material-docs/core/components/Markdown/Markdown";
9+
import logo from "./images/MaterialDocsLogoOverview.svg"
10+
11+
import content from "./introduction.md";
12+
13+
export default function Introduction() {
14+
return (
15+
<DocsPage
16+
name={"Introduction"}
17+
searchTags={["introduction", "material", "docs", "about", "why"]}
18+
searchLabel={"Introduction to Material Docs."}
19+
order={1}
20+
>
21+
<Markdown
22+
data={{
23+
locale: "pages/IntroductionPage",
24+
logo: logo
25+
}}
26+
children={content}
27+
/>
28+
</DocsPage>
29+
);
30+
}

‎src/pages/GettingStarted/Introduction/introduction.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
![{"alt": "GitHub Pages", "src": "&&logo", "fullWidth": true}]()
2+
# &{&&locale/headers/introduction}&
3+
## &{&&locale/headers/what}&
4+
&{&&locale/what}&
5+
## &{&&locale/headers/why}&
6+
* &{&&locale/why1}&
7+
* &{&&locale/why2}&
8+
* &{&&locale/why3}&
9+
* &{&&locale/why4}&
10+
* &{&&locale/why5}&
11+
* &{&&locale/why6}&
12+
* &{&&locale/why7}&
13+
14+
## &{&&locale/headers/mui}&
15+
&{&&locale/mui}&
16+
17+
## &{&&locale/headers/docs}&
18+
&{&&locale/docs}&
19+
* __Getting started__ - &{&&locale/docsPart1}&
20+
* __Tutorials__ - &{&&locale/docsPart2}&
21+
* __Components__ - &{&&locale/docsPart3}&
22+
* __Component APIs__ - &{&&locale/docsPart4}&
23+
* __Extensions__ - &{&&locale/docsPart5}&

‎src/pages/MaterialDocsLanding/exampleCode.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<DocsLayout
2+
name={"My documentation"}
3+
version={"1.0.0-alpha"}
4+
logo={"http://material-docs.com/static/media/logo.5a237c82.svg"}
5+
keywords={["my", "test", "documentation"]}
6+
description={"This is an example documentation for Material Docs framework."}
7+
author={"Danil Andreev"}
8+
>
9+
<DocsMenu>
10+
<AutoDocsMenu />
11+
</DocsMenu>
12+
<DocsPages>
13+
<PagesGroup name={"My Group"}>
14+
{/*...*/}
15+
</PagesGroup>
16+
<SecondPage/>
17+
</DocsPages>
18+
</DocsLayout>

‎src/pages/MaterialDocsLanding/index.js

+10-8
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ import demoScreenshotDesktop1 from "./images/demo-screenshot-desktop-1.png";
2929
import demoScreenshotDesktop2 from "./images/demo-screenshot-desktop-2.png";
3030
import Divider from "@material-ui/core/Divider";
3131
import useSwitchPage from "@material-docs/core/hooks/useSwitchPage";
32+
import exampleCode from "./exampleCode.md";
33+
import BuildIcon from '@material-ui/icons/Build';
3234

3335
export default function MaterialDocsLanding() {
3436
const classes = useStyles();
@@ -110,7 +112,7 @@ export default function MaterialDocsLanding() {
110112
experience. But it is optional.</Typography>
111113
<Code
112114
theme={"darcula"}>{"$ npm install @material-ui/core\n$ npm install @material-ui/icons"}</Code>
113-
<CardActions>
115+
<CardActions >
114116
<Button onClick={() => switchPage(["Getting started", "Installation"])}>
115117
Read installation docs
116118
</Button>
@@ -124,20 +126,20 @@ export default function MaterialDocsLanding() {
124126
<Card className={classes.card}>
125127
<CardHeader
126128
avatar={
127-
<Avatar><GetAppIcon/></Avatar>
129+
<Avatar><BuildIcon/></Avatar>
128130
}
129131
title={<Typography variant={"h6"}>Installation</Typography>}
130132
/>
131133
<CardContent>
132134
<Typography>MaterialDocs components work without any additional setup, and don't
133135
pollute
134136
the global scope.</Typography>
135-
<Code theme={"darcula"}>$ npm install @material-docs/core</Code>
136-
<CardActions>
137-
<Button onClick={event => switchPage(["Tutorials", "Creating Material Docs"])}>
138-
Explore the docs
139-
</Button>
140-
</CardActions>
137+
<Code theme={"darcula"}>{exampleCode}</Code>
138+
{/*<CardActions>*/}
139+
{/* <Button onClick={event => switchPage(["Tutorials", "Creating Material Docs"])}>*/}
140+
{/* Explore the docs*/}
141+
{/* </Button>*/}
142+
{/*</CardActions>*/}
141143
</CardContent>
142144
</Card>
143145
</Box>

0 commit comments

Comments
 (0)