Лабораторная работа 1

Тема: Создание и развертывание статического сайта на базе MkDocs с публикацией на GitHub Pages

Цель работы

• Освоить создание статического сайта с использованием MkDocs.
• Научиться организовывать структуру документации проекта.
• Изучить основы работы с Git и GitHub.
• Развернуть сайт на GitHub Pages на домене вида username.github.io.
• Освоить настройку темы оформления и файла mkdocs.yml.

Самостоятельная часть

Выбор и подключение темы оформления

Выбрана тема: Dracula

Обоснование: - Тёмная схема снижает нагрузку на глаза; - Встроенная подсветка синтаксиса для кода; - Минималистичный дизайн для портфолио разработчика;

Установка:

pip install mkdocs-dracula-theme

site_name: "Aleksandr Lesnitsky - Portfolio"
site_url: https://fafakaj.github.io/
site_author: "Aleksandr Lesnitsky"

theme:
  name: dracula
  highlightjs: true
  hljs_style: dracula

nav:
  - Главная: index.md
  - Об авторе: about.md
  - Лабораторные работы:
    - Список работ: labs/index.md
    - Лаба 1: labs/lab1.md
  - Проекты: projects.md
  - Контакты: contact.md

Структура страниц

docs/
├── index.md          # Главная
├── about.md          # Об авторе
├── projects.md       # Проекты
├── contact.md        # Контакты
└── labs/
    ├── index.md      # Список лабораторных
    └── lab1.md       # Отчёт по работе 1

Навигация

Навигация настроена через параметр nav в файле mkdocs.yml. Реализована иерархическая структура с вложенными разделами для лабораторных работ.

Сайт доступен: https://fafakaj.github.io/

Выводы

• Освоено создание статического сайта на MkDocs.
• Изучена организация структуры документации.
• Получены навыки работы с Git и GitHub Pages.