Markdown для начинающих: от первой заметки до README

Научитесь оформлять понятные заметки, инструкции и страницы проектов с помощью Markdown. Начните с обычного текстового файла, разберитесь с разметкой на коротких примерах и соберите собственный README — вводный документ для нового читателя.

Кому подойдёт курс

• Тем, кто впервые встретил файл с расширением .md.
• Учащимся, которые хотят аккуратно вести конспекты.
• Авторам инструкций и памяток.
• Участникам учебных и рабочих проектов, которым нужно оформить README.

HTML, программирование и терминал знать не нужно. Достаточно уметь создавать папки и сохранять текстовые файлы.

Чему вы научитесь

• Различать исходный текст и результат его отображения.
• Создавать заголовки, абзацы, выделения и списки.
• Показывать точные символы, имена файлов и многострочные примеры.
• Добавлять ссылки и изображения с осмысленным альтернативным текстом.
• Работать с относительными путями и находить сломанные ссылки.
• Использовать таблицы, чек-листы и зачёркивание в среде с поддержкой GFM.
• Проверять структуру и переносимость документа.
• Создавать README, отвечающий на вопросы нового участника проекта.

Как устроено обучение

В курсе 4 модуля и 12 уроков. Каждый урок содержит три коротких объяснения, самостоятельное упражнение и два теста. Всего 72 шага и 24 тестовых задания с объяснениями ответов.

Упражнения выполняются в своих файлах. В каждом есть критерии самопроверки. Итоговая работа — README клуба чтения или другого небольшого проекта по вашему выбору. Автоматическая проверка файлов и ручное рецензирование в эту версию курса не входят; баллы предусмотрены за отдельные тесты.

Для начала достаточно «Блокнота» в Windows или TextEdit в режиме простого текста на Mac и браузера. В первом уроке вы создадите TXT-файл, напишете разметку и переименуете его в MD. Результат можно увидеть в онлайн-предпросмотре CommonMark без установки Markdown-редактора. Готовые MD-файлы редактируются тем же обычным текстовым редактором. Для урока о расширениях понадобится предпросмотр с поддержкой GitHub Flavored Markdown; если его нет, в задании предложен запасной вариант обычным текстом.

Ориентировочная продолжительность — 4–6 часов вместе с практикой и итоговым проектом. Можно проходить курс в своём темпе.

Что получится в конце

У вас останется набор учебных документов и законченный README. Вы сможете применять те же приёмы в конспектах, памятках и инструкциях и проверять результат в той среде, где его будет читать аудитория.