Mdp — презентации Markdown в терминале

Mdp — лёгкий инструмент для создания и показа презентаций в формате Markdown прямо из терминала. Удобен для быстрых технических демонстраций, докладов без графики и автоматизированных презентаций. Ниже — установка, примеры слайдов, сочетания клавиш, шаблоны, чек-листы и советы по устранению проблем.

Что такое Mdp

Mdp — это инструмент для показа презентаций, который работает в командной строке и рендерит слайды из Markdown-файлов. Проект начался как учебный пример на C и вырос в удобный минималистичный инструмент для презентаций без GUI.

Важно: Mdp не предназначен для сложной графики или анимации — он фокусируется на тексте и простом оформлении.

Кому подходит

• Разработчикам, докладчикам и преподавателям, которые часто работают в терминале.
• Тем, кто хочет быстро подготовить презентацию без лишних визуальных эффектов.
• Для автоматизированных CI/CD презентаций, где генерируется Markdown.

Установка

Для Debian-подобных систем выполните следующие команды в терминале (правильная последовательность и пробелы важны):

sudo apt-get install git gcc make libncursesw5-dev
git clone https://github.com/visit1985/mdp.git
cd mdp
make
sudo make install

Если вы используете другую дистрибуцию Linux, откройте страницу проекта на GitHub и следуйте инструкциям по установке для вашего дистрибутива.

Совет: при возникновении ошибок сборки убедитесь, что установлены пакеты для разработки (build-essential или эквивалент).

Быстрое использование

Создайте файл презентации в формате Markdown (.md) и запустите:

mdp my-presentation.md

Основные сочетания клавиш в Mdp:

• Далее: Enter, Space, Page Down, j, l, ↓, →
• Назад: Backspace, Page Up, h, k, ↑, ←
• Выйти: q
• Перезагрузить слайды: r
• Перейти к первому слайду: Home или g
• Перейти к последнему слайду: End или G

Пример первого слайда

Ниже — пример заголовка, автора и краткого описания. Строки с % используются для метаданных.

%title: Maketecheasier - Mdp
%author: Himanshu

-> mdp  A command-line based markdown presentation tool.

This is how it looks:

После строки с метаданными идёт содержимое слайда. Символы подчеркивания, стрелки и другие спецсимволы можно экранировать обратным слэшем.

Разделение на слайды

Слайды разделяются горизонтальной чертой — минимум три символа * или -. Примеры разделителей, каждый — начало нового слайда:

* * *
---
************************
- - -

Пример с многоуровневыми заголовками и вложенными списками

-> # Многоуровневые заголовки и вложенные списки

- Пункт 1
  - Подпункт 1.1
  - Подпункт 1.2
- Пункт 2

Это выглядит компактно и удобно для перечислений, которые вы хотите показывать по пунктам (см. ниже про построчную подачу).

Важно: одинарный пробел или символ ^ на отдельной строке заставляют mdp остановить вывод на этой позиции — удобно для показа пунктов по очереди.

Форматирование блоков кода

Блоки кода определяются отступом в 4 пробела. Пример:

-> # Форматирование блока кода
    int main(void)
    {
        printf("\nHello World\n");
        return 0;
    }

Это пример inline-кода: `gcc -Wall helloworld.c -o helloworld`

Полезные приёмы и советы

• Экранируйте спецсимволы с помощью обратного слэша \ если нужно вывести *, _, # и т. п.
• Цитаты: используйте > в начале строки; несколько > создают вложенные цитаты.
• Пробуйте файл sample.md, который идёт с исходниками mdp — он содержит готовые приёмы и шаблоны.

Важно: mdp рендерит текст в текущем размере терминала; перед презентацией проверьте размер окна.

Шаблон файла презентации (минимальный)

%title: Мой доклад
%author: Иван Иванов

-> # Слайд 1
Короткое описание...

---

-> # Слайд 2
- Пункт A
- Пункт B

---

-> # Код
    echo "Hello, mdp"

Сохраните как my-talk.md и запустите mdp my-talk.md.

Чек-лист для ролей

Presenter (докладчик):

• Проверить видимость текста на стандартном размере терминала.
• Проверить навигацию — клавиши вперед/назад.
• Подготовить заметки вне mdp (mdp выводит только слайды).

Developer / Документатор:

• Хранить презентации в репозитории как Markdown.
• Добавлять CI-проверки на синтаксис Markdown если релевантно.

Reviewer / Коллега:

• Проверить структуру: заголовки, логический порядок слайдов.
• Предложить удаление лишних деталей для простоты чтения в терминале.

Когда mdp — плохой выбор (контрпример)

• Нужно много графики, диаграмм или анимации — используйте GUI-решения (PowerPoint, LibreOffice Impress, reveal.js).
• Если аудитория ожидает полированную визуальную подачу с брендингом — mdp не заменит дизайнерские шаблоны.

Альтернативы

• reveal.js — HTML/JS презентации, хорошо для браузера и сложной верстки.
• deck.md / terminal-slides — другие CLI-решения с разной функциональностью.

Выбор зависит от требований: если нужна простота и скорость — mdp; если важна визуализация — выбрать HTML/GUI.

Руководство по устранению проблем

• Проблема: нечитаемый текст — Убедитесь в размере шрифта и размера терминала; используйте минималистичные шрифты в эмуляторе терминала.
• Проблема: ошибки сборки make — установите dev-пакеты и зависимости: заголовки ncurses, компилятор и make.
• Проблема: некорректный рендер Markdown — проверьте пробелы и отступы в файле, особенно перед блоками кода.

Поток принятия решения — какую технологию выбрать

flowchart TD
  A[Нужна ли графика и брендинг?] -->|Да| B[Использовать reveal.js или GUI]
  A -->|Нет| C[Нужна быстрая подготовка и терминал?]
  C -->|Да| D[Использовать mdp]
  C -->|Нет| B

Критерии приёмки

• Презентация открывается командой mdp имя_файла.md без ошибок.
• Все слайды читаемы на стандартном размере терминала 80×24 или большем.
• Навигация по слайдам работает: вперед/назад/выход.

Часто задаваемые вопросы

Q: Можно ли показывать пункты по одному?

A: Да — используйте одиночную строку с пробелом или символ ^, чтобы mdp приостанавливал вывод и позволял перейти к следующему элементу вручную.

Q: Поддерживает ли mdp цветовой синтаксис для кода?

A: Mdp рендерит монохромный текст; цветовая подсветка зависит от вашей терминальной среды и настроек.

Q: Можно ли экспортировать слайды в PDF?

A: У mdp нет встроенного экспорта в PDF; можно записать сессию терминала (например, asciinema), либо преобразовать Markdown в HTML/PDF с помощью других инструментов.

Краткое резюме

Mdp — отличное средство для быстрых и текстовых презентаций прямо в терминале. Он прост в установке и использовании, хорошо подходит для технических докладов и автоматизированных сценариев. Если вам важна графика или фирменный стиль — рассмотрите HTML/GUI альтернативы.

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