Перейти к содержанию
Lesson Loom
Меню
Все материалы

Заметки, которые останутся с вами

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

Markdown5 мин чтения

Markdown позволяет обозначить структуру текста обычными символами: решёткой, звёздочками, скобками. Результат хранится в текстовом файле, а редактор показывает заголовки, списки и ссылки в удобном виде. Это полезно для конспектов, рабочих инструкций и небольших личных справочников, которые хочется сохранить независимо от конкретного приложения.

Начинать лучше с одного настоящего документа. Например, запишите, как вы готовитесь к учебному занятию. После этого попробуйте открыть файл другим редактором. Если смысл понятен и без красивого оформления, вы уже используете главное преимущество формата.

Создайте первый файл

Откройте текстовый редактор, создайте документ study-plan.md и сохраните его в кодировке UTF-8. Расширение .md подсказывает приложениям, что внутри находится Markdown. Сам файл остаётся текстом: специальная база данных для него не нужна.

Проверьте, что редактор действительно сохранил нужное расширение. В некоторых программах документ может незаметно превратиться в study-plan.md.txt. Включите отображение расширений в файловом менеджере и посмотрите полное имя. Папку для примеров можно назвать Мои заметки; сложная структура пока не требуется.

Обозначьте структуру, а не внешний вид

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

# Как я готовлюсь к занятию

## До начала

Проверяю прошлый конспект и формулирую один вопрос.

## После занятия

Объясняю новую идею своими словами.

Между абзацами оставляйте пустую строку. Один перенос строки в исходнике не всегда превращается в видимый перенос при просмотре: поведение зависит от редактора. Для обычной заметки отдельных абзацев достаточно, а принудительные разрывы удобнее использовать только при реальной необходимости.

Используйте списки по назначению

Маркированный список подходит для равноправных пунктов: материалов, вопросов, вариантов. Нумерованный нужен там, где важна последовательность действий. Если пункты сложно отличить от длинных абзацев, попробуйте сначала сократить формулировки.

Что приготовить:

- прошлый конспект;
- одну практическую задачу;
- место для новых вопросов.

Порядок работы:

1. Вспомнить тему без подсказки.
2. Решить небольшую задачу.
3. Сверить результат с источником.

Вложенные списки требуют аккуратных отступов. Поскольку правила могут различаться в деталях, проверяйте результат в предпросмотре. Не превращайте первые заметки в упражнение по сложной вёрстке: один уровень обычно читается быстрее.

Добавляйте ссылки и изображения

У ссылки есть понятная подпись в квадратных скобках и адрес в круглых. Подпись должна объяснять, что откроется. Формулировка «справочник Markdown» полезнее, чем «нажмите здесь».

[Справочник CommonMark](https://commonmark.org/help/)

![Схема подготовки к занятию](images/study-flow.png)

Изображение отличается восклицательным знаком перед подписью. Текст в скобках описывает содержание картинки и помогает, когда она недоступна. Саму картинку Markdown внутрь файла не помещает: это ссылка на отдельный ресурс. Поэтому для переноса заметки нужно забрать и файл из папки images.

С относительными путями удобнее переносить целую папку. Если файл лежит рядом с заметкой, укажите его имя; если в подпапке — путь от заметки. Не используйте абсолютный путь к своему компьютеру, когда документом будет пользоваться другой человек.

Выделяйте смысл умеренно

Две звёздочки обозначают полужирное выделение, одна — курсив. Короткий фрагмент кода или имя файла можно заключить в обратные кавычки: study-plan.md. Большой пример оформляют отдельным блоком между строками с тремя обратными кавычками.

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

Соберите заметку, которую можно использовать

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

# Повторение перед новым занятием

Цель: понять, что осталось в памяти после прошлой встречи.

## Сделать

1. Закрыть конспект.
2. Записать три основных положения темы.
3. Придумать свой пример.
4. Открыть конспект и исправить неточности.

## Готово, когда

Я могу объяснить идею без чтения исходного текста.

## Остался вопрос

Где этот способ перестаёт работать?

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

Учитывайте границы переносимости

У Markdown есть варианты и расширения. Таблицы, чекбоксы, формулы и ссылки вида [[Имя заметки]] поддерживаются не везде одинаково. CommonMark описывает базовый синтаксис; дополнительные возможности нужно проверять в целевом приложении.

Для долговечных документов начинайте с заголовков, абзацев, обычных ссылок и списков. Экспортируйте одну типичную заметку вместе с вложениями и откройте её вне основного приложения. Проверьте кириллицу, ссылки, картинки и блоки кода. Такой маленький эксперимент полезнее обещания «всё можно будет перенести потом».

Частые ошибки

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

Другая ошибка — оформлять заметку дольше, чем работать с её содержанием. Если вы открыли документ ради ответа на конкретный вопрос, сначала запишите ответ и пример. И только затем решайте, нужна ли таблица или дополнительный уровень заголовков.

Чек-лист

  • Файл имеет расширение .md и открывается как текст.
  • У документа понятный заголовок, а у разделов — последовательные уровни.
  • Ссылки подписаны, изображения лежат рядом с заметкой.
  • Внешние идеи отделены от собственных и снабжены источником.
  • Пример заметки проверен в другом редакторе.

Источники и дальнейшее чтение