Skip to content

Commit 719e296

Browse files
authored
Update README.md
1 parent cd24647 commit 719e296

File tree

1 file changed

+19
-21
lines changed

1 file changed

+19
-21
lines changed

README.md

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,26 @@
1-
# Проект документации с MkDocs
1+
# Персональное резюме с MkDocs
22

3-
Этот проект использует [MkDocs](https://www.mkdocs.org/) для создания документации. Ниже приведены инструкции по установке, настройке и развертыванию документации.
3+
Этот проект представляет собой резюме, созданное с использованием [MkDocs](https://www.mkdocs.org/). Ниже приведены инструкции по установке, настройке и развертыванию.
44

55
## Установка
66

77
Перед началом работы установите `mkdocs` и необходимые плагины:
88

99
```sh
10-
pip install mkdocs
11-
```
12-
13-
Для поддержки тем и расширений можно установить дополнительные пакеты:
14-
15-
```sh
16-
pip install mkdocs-material
10+
pip install mkdocs mkdocs-material
1711
```
1812

1913
## Структура проекта
2014

21-
Структура проекта с документацией будет выглядеть следующим образом:
15+
Структура проекта выглядит следующим образом:
2216

2317
```
24-
project_root/
18+
resume_project/
2519
├── docs/
26-
│ ├── index.md # Главная страница
27-
│ ├── about.md # О проекте
20+
│ ├── index.md # Главная страница с резюме
21+
│ ├── experience.md # Опыт работы
22+
│ ├── education.md # Образование
23+
│ ├── skills.md # Навыки
2824
├── mkdocs.yml # Конфигурационный файл
2925
```
3026

@@ -33,17 +29,19 @@ project_root/
3329
Файл `mkdocs.yml` содержит настройки проекта. Пример:
3430

3531
```yaml
36-
site_name: "Моя Документация"
32+
site_name: "Резюме"
3733
theme:
3834
name: "material"
39-
nav:
35+
navigation:
4036
- Главная: index.md
41-
- О проекте: about.md
37+
- Опыт работы: experience.md
38+
- Образование: education.md
39+
- Навыки: skills.md
4240
```
4341
4442
## Запуск локального сервера
4543
46-
Для просмотра документации во время разработки запустите сервер:
44+
Для просмотра резюме во время редактирования запустите сервер:
4745
4846
```sh
4947
mkdocs serve
@@ -53,7 +51,7 @@ mkdocs serve
5351

5452
## Сборка статических файлов
5553

56-
Для сборки статической версии документации выполните:
54+
Для сборки статической версии резюме выполните:
5755

5856
```sh
5957
mkdocs build
@@ -63,14 +61,14 @@ mkdocs build
6361

6462
## Развертывание на GitHub Pages
6563

66-
Для публикации документации на GitHub Pages используйте команду:
64+
Для публикации резюме на GitHub Pages используйте команду:
6765

6866
```sh
6967
mkdocs gh-deploy
7068
```
7169

72-
Это автоматически создаст и загрузит документацию в ветку `gh-pages` вашего репозитория.
70+
Это автоматически создаст и загрузит резюме в ветку `gh-pages` вашего репозитория.
7371

7472
## Заключение
7573

76-
Теперь ваш проект готов к использованию с MkDocs. Вы можете редактировать `.md` файлы в папке `docs/`, обновлять `mkdocs.yml` и развертывать изменения через `mkdocs gh-deploy`.
74+
Теперь ваше резюме доступно в формате статического сайта. Вы можете редактировать `.md` файлы в папке `docs/`, обновлять `mkdocs.yml` и развертывать изменения через `mkdocs gh-deploy`.

0 commit comments

Comments
 (0)