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

Commit 3057c60

Browse files
DanilAndreevDanilAndreev
committed
Merge branch 'prod'
# Conflicts: # docs/static/js/185.c7a8a1ef.chunk.js.map
2 parents 08b99a9 + 254bd43 commit 3057c60

19 files changed

+624
-127
lines changed

‎docs/static/js/185.c7a8a1ef.chunk.js.map

-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/static/media/back1_v002.d952e7d1.png

-3.51 MB
Loading

‎package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@material-docs/material-docs-documentation",
3-
"version": "0.1.6",
3+
"version": "0.1.7",
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/",
@@ -30,7 +30,7 @@
3030
"license": "MIT",
3131
"dependencies": {
3232
"@craco/craco": "^5.6.4",
33-
"@material-docs/core": "^0.4.9",
33+
"@material-docs/core": "^0.5.3",
3434
"@material-docs/react-components-docs-extension": "^0.2.0",
3535
"@material-ui/core": "^4.11.0",
3636
"@material-ui/icons": "^4.9.1",

‎src/Documentation.js

+2
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ import LangProviderAPI from "./pages/APIs/LangProviderAPI";
7272
import LocaleAPI from "./pages/APIs/LocaleAPI";
7373
import LandingAPI from "./pages/APIs/LandingAPI";
7474
import LinkAPI from "./pages/APIs/LinkAPI";
75+
import HostingMaterialDocsOnGHPages from "./pages/Tutorials/HostingMaterialDocsOnGHPages";
7576

7677

7778
export default function Documentation() {
@@ -114,6 +115,7 @@ export default function Documentation() {
114115
</PagesGroup>
115116
<PagesGroup name={"Tutorials"} order={2}>
116117
<CreatingMaterialDocs/>
118+
<HostingMaterialDocsOnGHPages/>
117119
</PagesGroup>
118120
<PagesGroup name={"Components"} order={3}>
119121
<CodeDemo/>

‎src/locale/EN.json

+41
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,47 @@
33
"label": "English",
44
"locale": {
55
"pages": {
6+
"CreatingMaterialDocsTutorial": {
7+
"headers": {
8+
"creatingMaterialDocs": "Creating Material Docs",
9+
"creatingProject": "Creating project",
10+
"materialDocsSetup": "Material Docs setup",
11+
"indexSetup": "Setting up index.html",
12+
"extraFilesDeleting": "Extra files deletion",
13+
"creatingDocs": "Создание документации",
14+
"basicStructure": "Basic structure",
15+
"creatingPage": "Creating page",
16+
"creatingPageComponent": "Creating page component",
17+
"creatingAnotherPage": "Creating another page",
18+
"pagesGrouping": "Группирование страниц",
19+
"pagesRedirecting": "Redirecting between pages",
20+
"result": "Result",
21+
"gitHubSources": "GitHub sources"
22+
},
23+
"creatingProjectText": "Let's create a new project using the utility __create-react-app__. More about this utility [here](&&createReactAppLink). \nWe named the project _material-docs-example-project_ :).",
24+
"setup": "After the project is created, you need to install Material Docs. ",
25+
"withYarn": "Using __yarn__:",
26+
"withNpm": "Using __npm__:",
27+
"indexSetup": "Material Docs uses the _Roboto_ font, let's install it.\nIn the directory __public__ add to file ___index.html___ the next:\n",
28+
"indexOverview": "File ___index.html___ should look something like this:",
29+
"deleteFiles": "You can delete files:",
30+
"basicStructure": "First, let's create the following structure in the __index.js__ file:",
31+
"indexJsDescription": "This is the basic structure for a Material Docs app. \nWe have specified the following parameters for the component ```<DocsLayout/>```:",
32+
"props": {
33+
"name": "Documentation name.",
34+
"version": "Documentation version.",
35+
"logo": "Path to logo image.",
36+
"keywords": "Key words of the page so that search engines can index it.",
37+
"description": "Page description for metadata.",
38+
"author": "Author's name."
39+
},
40+
"moreInfo": "You can get more information on components in the __Component APIs__ section of this documentation. For example, here is [__documentation of the component__ ```<DocsLayout/>```](). \n\nIn the ```<DocsMenu/>``` component stored information about menu structure. Component ```<AutoDocsMenu/>``` allows don't think about creating the menu manually. \n\nInside ```<DocsPages/>``` component there will be pages. ",
41+
"creatingPage": "Let's start writing the information page. Create a page about yourself:",
42+
"creatingPageComponent": "In order to make it easier to edit pages, we recommend creating page components and placing them in separate files. For example, let's wrap our page in a component:",
43+
"pagesGrouping": "In order for the automatic menu to create groups of pages, they must be wrapped in a ```<PagesGroup/>``` component. \nLet's wrap the FirstPage in a group \"My Group\"",
44+
"redirecting": "The ```<Link/>``` component has ___page___ prop,in which the path is passed to the inner page. \nSince the page we want to redirect to is in the __My Group__, the path will look like this:",
45+
"githubExample": "You can find this example on GitHub [here](&&gitHubSource)"
46+
},
647
"TablesDemo": {
748
"searchDescription": "Demo of Table parts components.",
849
"searchTags": {

‎src/locale/RU.json

+41
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,47 @@
33
"label": "Русский",
44
"locale": {
55
"pages": {
6+
"CreatingMaterialDocsTutorial": {
7+
"headers": {
8+
"creatingMaterialDocs": "Создание Material Docs",
9+
"creatingProject": "Создание проекта",
10+
"materialDocsSetup": "Установка Material Docs",
11+
"indexSetup": "Настройка index.html",
12+
"extraFilesDeleting": "Удаление ненужных файлов",
13+
"creatingDocs": "Создание документации",
14+
"basicStructure": "Базовая структура",
15+
"creatingPage": "Создание страницы",
16+
"creatingPageComponent": "Создание страничного компонента",
17+
"creatingAnotherPage": "Создадим еще одну страницу",
18+
"pagesGrouping": "Группирование страниц",
19+
"pagesRedirecting": "Переадресация между страницами",
20+
"result": "Результат",
21+
"gitHubSources": "Исходники на GitHub"
22+
},
23+
"creatingProjectText": "Создадим новый проект с помощью утилиты __create-react-app__. Подробнее об этой утилите [здесь](&&createReactAppLink). \nМы назвали проект _material-docs-example-project_ :).",
24+
"setup": "После того, как проект создан - надо установить Material Docs. ",
25+
"withYarn": "С помощью __yarn__:",
26+
"withNpm": "С помощью __npm__:",
27+
"indexSetup": "Material Docs использует шрифт _Roboto_, давайте установим его.\nВ директории __public__ добавьте в файл ___index.html___ следующее:\n",
28+
"indexOverview": "Файл ___index.html___ должен выглядеть примерно так:",
29+
"deleteFiles": "Вы можете удалить файлы:",
30+
"basicStructure": "Для начала, создадим в файле __index.js__ следующую структуру:",
31+
"indexJsDescription": "Это базовая структура для приложения Material Docs. \nМы указали следующие параметры для компонента ```<DocsLayout/>```:",
32+
"props": {
33+
"name": "Название документации.",
34+
"version": "Версия документации.",
35+
"logo": "Путь к картинке логотипу.",
36+
"keywords": "Ключевые слова страницы для того, чтоб поисковые движки могли проиндексировать её.",
37+
"description": "Описание страницы для метаданных.",
38+
"author": "Имя автора."
39+
},
40+
"moreInfo": "Больше информации о компонентах вы можете получить в разделе __Component APIs__ этой документации. К примеру,\nвот [__документация компонента__ ```<DocsLayout/>```](). \n\nВ компоненте ```<DocsMenu/>``` хранится информация о структуре меню. Компонент ```<AutoDocsMenu/>``` позволяет \nне задумываться о создании меню вручную. \n\nВнутри компонента ```<DocsPages/>``` будут находиться страницы. ",
41+
"creatingPage": "Приступим к написанию страницы с информацией. Создадим страницу о себе:",
42+
"creatingPageComponent": "Для того, чтоб было удобнее редактировать страницы мы рекомендуем создавать страничные компоненты и размещать их в \nотдельных файлах. Например, обернем нашу страницу в компонент:",
43+
"pagesGrouping": "Для того, чтоб автоматическое меню могло создавать группы страниц, их надо оборачивать в компонент ```<PagesGroup/>```. \nДавайте обернём страницу FirstPage в группу \"My Group\"",
44+
"redirecting": "У компонента ```<Link/>``` есть параметр ___page___, в который передается путь внутренней странице. \nТак как страница, на которую мы хотим сделать переадресацию находится в группе __My Group__ - путь будет выглядеть так:",
45+
"githubExample": "Вы можете найти этот пример на GitHub [здесь](&&gitHubSource)"
46+
},
647
"TablesDemo": {
748
"searchDescription": "Demo of Table parts components.",
849
"searchTags": {

0 commit comments

Comments
 (0)