You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Этот проект использует [MkDocs](https://www.mkdocs.org/) для создания документации. Ниже приведены инструкции по установке, настройке и развертыванию документации.
3
+
Этот проект представляет собой резюме, созданное с использованием [MkDocs](https://www.mkdocs.org/). Ниже приведены инструкции по установке, настройке и развертыванию.
4
4
5
5
## Установка
6
6
7
7
Перед началом работы установите `mkdocs` и необходимые плагины:
8
8
9
9
```sh
10
-
pip install mkdocs
11
-
```
12
-
13
-
Для поддержки тем и расширений можно установить дополнительные пакеты:
14
-
15
-
```sh
16
-
pip install mkdocs-material
10
+
pip install mkdocs mkdocs-material
17
11
```
18
12
19
13
## Структура проекта
20
14
21
-
Структура проекта с документацией будет выглядеть следующим образом:
15
+
Структура проекта выглядит следующим образом:
22
16
23
17
```
24
-
project_root/
18
+
resume_project/
25
19
├── docs/
26
-
│ ├── index.md # Главная страница
27
-
│ ├── about.md # О проекте
20
+
│ ├── index.md # Главная страница с резюме
21
+
│ ├── experience.md # Опыт работы
22
+
│ ├── education.md # Образование
23
+
│ ├── skills.md # Навыки
28
24
├── mkdocs.yml # Конфигурационный файл
29
25
```
30
26
@@ -33,17 +29,19 @@ project_root/
33
29
Файл `mkdocs.yml` содержит настройки проекта. Пример:
34
30
35
31
```yaml
36
-
site_name: "Моя Документация"
32
+
site_name: "Резюме"
37
33
theme:
38
34
name: "material"
39
-
nav:
35
+
navigation:
40
36
- Главная: index.md
41
-
- О проекте: about.md
37
+
- Опыт работы: experience.md
38
+
- Образование: education.md
39
+
- Навыки: skills.md
42
40
```
43
41
44
42
## Запуск локального сервера
45
43
46
-
Для просмотра документации во время разработки запустите сервер:
44
+
Для просмотра резюме во время редактирования запустите сервер:
47
45
48
46
```sh
49
47
mkdocs serve
@@ -53,7 +51,7 @@ mkdocs serve
53
51
54
52
## Сборка статических файлов
55
53
56
-
Для сборки статической версии документации выполните:
54
+
Для сборки статической версии резюме выполните:
57
55
58
56
```sh
59
57
mkdocs build
@@ -63,14 +61,14 @@ mkdocs build
63
61
64
62
## Развертывание на GitHub Pages
65
63
66
-
Для публикации документации на GitHub Pages используйте команду:
64
+
Для публикации резюме на GitHub Pages используйте команду:
67
65
68
66
```sh
69
67
mkdocs gh-deploy
70
68
```
71
69
72
-
Это автоматически создаст и загрузит документацию в ветку `gh-pages` вашего репозитория.
70
+
Это автоматически создаст и загрузит резюме в ветку `gh-pages` вашего репозитория.
73
71
74
72
## Заключение
75
73
76
-
Теперь ваш проект готов к использованию с MkDocs. Вы можете редактировать `.md` файлы в папке `docs/`, обновлять `mkdocs.yml` и развертывать изменения через `mkdocs gh-deploy`.
74
+
Теперь ваше резюме доступно в формате статического сайта. Вы можете редактировать `.md` файлы в папке `docs/`, обновлять `mkdocs.yml` и развертывать изменения через `mkdocs gh-deploy`.
0 commit comments