mkdocs-demo

Репозиторий для заданий 2.1 и 2.2 курса "Проектирование и развертывание веб-решений в экосистеме Python". Магистерская программа Веб-технологии, Университет ИТМО, 2024

Содержание

1. Шаги выполнения задания 2.1
2. Шаги выполнения задания 2.2

Задание 2.1

В задании нужно:

• на основе материалов создать и развернуть на GitHub Pages сайт, используя для этого генератор статических сайтов MkDocs,

• автоматизировать процесс деплоя сайта с помощью GitHub Actions.

Шаги выполнения задания

1. Создала репозиторий на GitHub, склонировала его.

2. Выполнила шаги из гайда Getting Started with MkDocs:

   • установила MkDocs при помощи команды: pip install mkdocs,

   • создала новый проект с названием mkdocs-demo при помощи команды: mkdocs new mkdocs-demo,

   • зашла в созданную директорию, запустила сервер при помощи команды: mkdocs serve,

   • внесла изменения в файл docs/index.md, чтобы изменить текст на главной странице,

   • попробовала другие команды из гайда: добавила img/favicon.ico, изменила дефолтную тему сайта на тему readthedocs.

3. Настроила автоматический деплой на GitHub Pages:

   • добавила директорию .github/workflows, в директории создала файл actions.yml с пошаговым описанием процесса сборки и деплоя проекта. Триггером для начала сборки и деплоя служит пуш новых коммитов в ветку main,

   • добавила файл mkdocs.yml с описанием структуры сайта.

Задание 2.2

В задании нужно:

• создать собственную тему для сайта на основе HTML, CSS и JS. При желании можно использовать различные библиотеки и/или фреймворки,

• разработать пайплайн (YAML-файл) для тестирования и сборки статического содержимого сайта, интеграции контента в шаблон сайта и автоматического деплоя на GitHub Pages. Требуется предусмотреть валидацию и минификацию HTML-файлов.

Шаги выполнения задания

1. Добавила файлы main.html и css/extra.css для создания собственной темы сайта: написала стили, отредактировала структуру страницы в main.html. Для шаблонизации использовала Jinja2.