Как пользоваться HackMD: совместные заметки в Markdown

HackMD осваивается за один вечер: редактор устроен просто, а вся сложность сводится к разметке Markdown, которой хватает в объёме десятка символов. Инструкция написана для работы в браузере на компьютере. В браузере телефона сервис тоже открывается, но набирать разметку на экранной клавиатуре неудобно — на телефоне заметку скорее читают.

Зарегистрируйтесь

Откройте hackmd.io и выберите вход. Зарегистрироваться можно по адресу электронной почты или через уже имеющийся аккаунт Google либо GitHub — второй вариант удобен, если документация будет лежать рядом с кодом. Интерфейс после входа появится на английском, русской версии у сервиса нет; все нужные кнопки подписаны короткими словами, и запомнить их несложно.

Создайте первую заметку

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

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

Освойте шесть правил разметки

Этого набора хватит для любой рабочей заметки:

• Заголовок — строка, которая начинается с решётки. Одна решётка — заголовок статьи, две — раздел, три — подраздел.
• Выделение — слово между двумя звёздочками с каждой стороны станет жирным, между одной — наклонным.
• Список — строки, начинающиеся с дефиса и пробела. Нумерованный список — строки, начинающиеся с цифры и точки.
• Задачи — пункт списка, после дефиса которого стоят квадратные скобки с пробелом внутри, превращается в пункт с галочкой, которую можно отметить мышкой.
• Ссылка — текст ссылки в квадратных скобках, сразу за ними адрес в круглых.
• Код — фрагмент между обратными кавычками. Для нескольких строк кода поставьте три обратные кавычки до и после.

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

Добавьте схему или формулу

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

Главное преимущество — схему потом правят как текст: добавить блок в диаграмму быстрее, чем перерисовывать картинку в графическом редакторе. Если в описании ошибка, вместо схемы в предпросмотре появится сообщение об ошибке; сверьте запись с примером из подсказки по разметке.

Настройте, кто видит заметку

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

Пригласите соавтора

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

Чтобы не мешать друг другу, договоритесь о разделах: один ведёт протокол, остальные дописывают свои пункты в отдельные подзаголовки. Замечания к тексту удобнее оставлять в комментариях под заметкой, а не прямо в абзаце.

Сохраните копию и верните прежнюю версию, если нужно

В меню заметки есть выгрузка: файл .md с чистой разметкой, PDF для отправки и готовый вид страницы. Скачивайте .md после каждой серьёзной правки — это обычный текстовый файл, который откроется в Obsidian, Typora, любом редакторе кода и даже в Блокноте.

Там же лежит история версий. Если кто-то удалил нужный кусок текста, откройте историю, найдите подходящий момент и скопируйте пропавший фрагмент обратно. Готово: заметка создана, доступ настроен, соавтор работает вместе с вами, а копия текста лежит у вас на компьютере.

Если что-то пошло не так