Skip to main content

CLI for hexlet.io

Project description

install

pip install hexlet

Руководство

Создание урока: hexlet-lesson init

Урок состоит из юнитов (theory, quiz, terminal, codex, code)

lesson.yml

  • units - список юнитов, которые необходимо открыть для этого урока. Здесь нужно перечислить то что вы реализовали.

  • mission - цель урока, то чему научатся те кто будут его проходить. Опционально.

Теория (theory unit)

  • В main.yml указывается id ролика на youtube.

  • main.ru.md - текст урока.

  • transcription.ru.md - расшифровка видео урока.

Тесты (quiz unit)

Поддерживаются два вида вопросов: с выбором ответа, и заполнением. Для каждого вопроса необходимо прописывать уникальный slug (ключ верхнего уровня). В main.yml есть примеры вопросов.

type: answers

Правильный ответ нужно писать первым. При выводе вопроса все ответы будут перемешаны.

type: filling

Правильный ответ заключается в ^(). При выводе вопроса на сайте, вместо этого placeholder будет показан html input.

Терминал (terminal unit)

# FIXME

Код в браузере (codex unit)

# FIXME

Код (code unit)

Для унификации и простоты работы, мы составили следующую схему: В папке code должен лежать файл Makefile который имеет три команды: * install - если необходимо делать установку доп библиотек, создавать файлы, менять права и т.п. * run - если нужно запускать, например, сервер. * test - основная команда, которая запускает тесты и по которой мы определяем выполненность задания.

Описания задания обязатально и должно находиться в файле README.md, который будет отображаться на сайте в соответствующем юните.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hexlet-0.0.15.tar.gz (9.5 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page