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

Цель

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

Задание

  • Создать публичный репозиторий на GitHub для размещения сайта-портфолио.
  • Настроить GitHub Pages так, чтобы публикация осуществлялась из каталога /docs ветки main.
  • Клонировать репозиторий на локальный компьютер.
  • Создать и активировать виртуальное окружение Python.
  • Установить MkDocs в виртуальное окружение.
  • Настроить файл .gitignore (исключить виртуальное окружение, служебные файлы и др.).
  • Создать новый сайт командой:
    mkdocs new source
  • Перейти в каталог source и запустить локальный сервер:
    cd source mkdocs serve
  • Выполнить сборку сайта в каталог /docs корня репозитория:
    mkdocs build -d ../docs
  • Выполнить коммит и отправку в удалённый репозиторий (включая каталог source и каталог docs).
  • Выбрать и подключить тему оформления (например, dracula, material или иную тему, подходящую для портфолио).
  • Настроить файл mkdocs.yml:
    • указать название сайта;
    • задать тему;
    • реализовать структуру меню через параметр nav.
    • Создать структуру страниц:
  • Главная страница;
  • Страница «Об авторе»;
  • Раздел «Лабораторные работы»;
  • отдельная страница для каждой лабораторной работы курса;
  • единый шаблон структуры отчёта (цель, задание, код, выводы).
  • Обеспечить корректную навигацию по сайту.
  • Выполнить повторную сборку и публикацию сайта.

Код

mkdocs.yml:

site_name: Портфолио

nav:
  - Home: index.md
  - About: about.md
  - Labs: labs.md`

theme: simple-blog

Выводы

По итогам вы полнения лабораторной работы продемонстрировано понимание: - принципов генерации статических сайтов; - организации структуры документации проекта; - процесса публикации проекта в сети Интернет без использования серверной части.

Обоснование выбранной темы представлено в README файле

Итогом работы стал статический сайт https://votemha.github.io/