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

Commit

Permalink
Merge pull request #18 from material-docs/prod
Browse files Browse the repository at this point in the history
Material Docs 0.1.8
  • Loading branch information
DanilAndreev authored Oct 5, 2020
2 parents d4ef11d + f4eff79 commit 0d7764d
Show file tree
Hide file tree
Showing 18 changed files with 325 additions and 1,104 deletions.
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@material-docs/material-docs-documentation",
"version": "0.1.7",
"version": "0.1.8",
"private": false,
"description": "Documentation for Material Docs. material-docs - react framework for easy creating documentation site in material design style.",
"homepage": "http://material-docs.com/",
Expand Down Expand Up @@ -30,7 +30,7 @@
"license": "MIT",
"dependencies": {
"@craco/craco": "^5.6.4",
"@material-docs/core": "^0.5.3",
"@material-docs/core": "^0.5.7",
"@material-docs/react-components-docs-extension": "^0.2.0",
"@material-ui/core": "^4.11.0",
"@material-ui/icons": "^4.9.1",
Expand Down
2 changes: 2 additions & 0 deletions src/Documentation.js
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ import LocaleAPI from "./pages/APIs/LocaleAPI";
import LandingAPI from "./pages/APIs/LandingAPI";
import LinkAPI from "./pages/APIs/LinkAPI";
import HostingMaterialDocsOnGHPages from "./pages/Tutorials/HostingMaterialDocsOnGHPages";
import AdvancedMaterialDocsUsage from "./pages/Tutorials/LocalizationWorkflow";


export default function Documentation() {
Expand Down Expand Up @@ -116,6 +117,7 @@ export default function Documentation() {
<PagesGroup name={"Tutorials"} order={2}>
<CreatingMaterialDocs/>
<HostingMaterialDocsOnGHPages/>
<AdvancedMaterialDocsUsage/>
</PagesGroup>
<PagesGroup name={"Components"} order={3}>
<CodeDemo/>
Expand Down
26 changes: 26 additions & 0 deletions src/locale/EN.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,32 @@
"label": "English",
"locale": {
"pages": {
"HostingMaterialDocsOnGHPagesTutorial": {
"headers": {
"hostingOnGH": "Хостинг Material Docs на GitHub Pages",
"projectSetup": "Настройка проекта для GitHub Pages",
"problem": "Проблема",
"solutionTheory": "Решение в теории",
"solutionPractice": "Решение на практике",
"repoCreating": "Создание репозитория",
"compilation": "Компиляция",
"ghPagesSetup": "Настройка GitHub Pages",
"basicSetup": "Базовая настройка",
"ownDomainHooking": "Привязывание собственного домена",
"nextSteps": "Дальнейшие шаги",
"ghSources": "Исходники на GitHub"
},
"prevTutorial": "Этот туториал использует проект, созданный в",
"prevLesson": "предыдущем уроке",
"overview": "Material Docs - это одно страничное React приложение, которое использует __react-router-dom__. Это означает, что\nпри переключении между страницами _URL_ меняется без перезагрузки страницы. Когда пользователь обращается на сайт, который \nхостится с помощью GitHub Pages, хостинг вернет страницу __index.thml__ или же ту, которая указана в _URL_. ",
"overview2": "Проще говоря, если мы захостим Material Docs на GitHub Pages без дополнительной настройки - при перезагрузке страницы \nбудем получать страницу __404 | Not found__.",
"suggestions": "Для того, чтоб предотвратить данную проблему, предлагается: \n* Создать страницу __404.html__, которая будет помещать путь из _URL_ в __query string__ запроса и делать редирект на \n_URL_, который ведет на __index.html__. \n* На странице __index.html__ мы будем обратно разбирать __query string__ и возвращать все на место __до того, как запустится react__.",
"jekyll": "Создайте файл __.nojekyll__ в директории __public__. Он нужен для того, чтоб GitHub Pages ну использовала фреймворк Jekyll.",
"jekyllNote": "По умолчанию, GitHub Pages использует",
"page404": "Теперь, необходимо добавить в директорию __public__ файл __404.html__ с таким содержанием:",
"segmentCount": "> Переменная ___segmentCount___ указывает количество элементов пути, которые не надо сериализовать. \n> В случае GitHub Pages - необходимо выставить значение ___segmentCount___ = 1. \n> Если вы собираетесь привязать собственный домен - посчитайте ___segmentCount___ и выставьте его.",
"pageIndex": "Далее, добавьте в файл __index.html__ в тэг _head_ следующий код:"
},
"CreatingMaterialDocsTutorial": {
"headers": {
"creatingMaterialDocs": "Creating Material Docs",
Expand Down
Loading

0 comments on commit 0d7764d

Please sign in to comment.