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

Commit 9d30a7d

Browse files
committed
[Tutorials] Added Hosting on GitHub Pages tutorial.
1 parent 5e74b7e commit 9d30a7d

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed

src/pages/Tutorials/HostingMaterialDocsOnGHPages/HostingMaterialDocsOnGHPages.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ $ yarn run build
121121
```{"type": "code", "themeLight": "darcula"}
122122
$ npm run build
123123
```
124-
Таким образом мы получили практически готовую к публикации веб страницу в директории __build__.
124+
Таким образом мы получили практически готовую к публикации веб страницу в директории __build__.
125125
Переименуйте эту директорию в __docs__.
126126
## Настройка GitHub Pages
127127
### Базовая настройка
@@ -130,3 +130,18 @@ $ npm run build
130130
В разделе __Source__ выберите целевую ветку и в поле __директория__ выберите ___/docs___. Сохраните настройки.
131131
![{"alt": "GitHub Pages", "src": "&&GitHubPagesSetupImage", "fullWidth": true, "frame": true}]()
132132
### Привязывание собственного домена
133+
> Для примера, мы будем использовать поддомен ___example.material-docs.com___
134+
> _Интерфейс управления доменом может отличаться в зависимости от вашего хостинга. В примере хостинг_ __Imena.ua__
135+
136+
Заходим в настройки домена и добавляем запись:
137+
![{"alt": "GitHub Pages", "src": "&&DNSSetup", "fullWidth": true, "frame": true}]()
138+
> Если вы используете не поддомен - вместо _example_ введите ___www___
139+
> _185.199.111.153 - адрес GitHub Pages на момент создания туториала._
140+
#### Дальнейшие шаги
141+
* Посчитайте значение параметра ___segmentCount___ в файле __404.html__. ([Как это сделать](#решение-на-практике))
142+
* В файле __package.json__ выставьте __свой домен__ в поле _homepage_.
143+
* Добавляем домен в настройки GitHub Pages в поле для домена.
144+
145+
![{"alt": "GitHub Pages", "src": "&&GitHubPagesDNSSetup", "fullWidth": true, "frame": true}]()
146+
## Исходники на GitHub
147+
Вы можете найти єтот пример пример на GitHub [здесь](https://github.com/material-docs/material-docs-example-project/tree/hosting-on-gh-pages)

src/pages/Tutorials/HostingMaterialDocsOnGHPages/index.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,13 @@ import Markdown from "@material-docs/core/components/Markdown/Markdown";
1010
import content from "./HostingMaterialDocsOnGHPages.md";
1111
import GitHubPagesInitialImage from "./images/GitHubPagesInitialImage.png";
1212
import GitHubPagesSetupImage from "./images/GitHubPagesSetupImage.png";
13+
import DNSSetup from "./images/DNSSetup.png";
14+
import GitHubPagesDNSSetup from "./images/GitHubPagesDNSSetup.png";
1315

1416
export default function HostingMaterialDocsOnGHPages() {
1517
return (
1618
<DocsPage
17-
name={"Hosting on gh-pages"}
19+
name={"Hosting on GitHub Pages"}
1820
searchTags={["create", "material", "docs", "tutorial", "faq", "manual"]}
1921
searchLabel={"Hosting you Material Docs based documentation on GitHub pages"}
2022
>
@@ -23,6 +25,8 @@ export default function HostingMaterialDocsOnGHPages() {
2325
locale: "pages/HostingMaterialDocsOnGHPagesTutorial",
2426
GitHubPagesInitialImage,
2527
GitHubPagesSetupImage,
28+
DNSSetup,
29+
GitHubPagesDNSSetup,
2630
}}
2731
children={content}
2832
/>

0 commit comments

Comments
 (0)