Вы пишете README с вложенными пунктами списка, парой блоков кода и таблицей, сравнивающей два подхода. В редакторе как обычный текст всё выглядит нормально. Затем вы отправляете это на GitHub, и таблица перекошена, один из блоков кода не закрылся как следует, а нумерованный список начался заново с единицы посередине из-за случайной пустой строки. Теперь вы делаете мелкие фикс-коммиты только ради того, чтобы форматирование стало правильным.
Markdown достаточно прост, чтобы писать его по памяти для базового форматирования, но у таблиц, вложенных списков и блоков кода есть свои небольшие синтаксические особенности, которые немного отличаются между рендерерами. GitHub Flavored Markdown не идентичен CommonMark, который не идентичен тому, что использует ваш генератор статических сайтов. Разрыв между «в голове выглядит правильно» и «на странице отрисовывается правильно» — именно то место, где предпросмотр в реальном времени окупается.
Почему коммит ради проверки — плохой рабочий процесс
Отправка коммита только ради того, чтобы увидеть, как отрисуется README, затем ещё один, чтобы исправить сломанную таблицу, затем ещё один, чтобы исправить исправление, засоряет историю коммитов шумом форматирования, не имеющим отношения к реальному содержанию. Это также означает, что каждый цикл предпросмотра занимает столько же времени, сколько push и перезагрузка страницы — достаточно долго, чтобы вы перестали проверять и просто понадеялись, что всё выглядит нормально.
Смотрите отрисованный результат по мере ввода
Bellows включает инструмент предпросмотра Markdown, который отрисовывает отформатированный результат по мере того, как вы вставляете или вводите сырой Markdown. Заголовки, списки, таблицы, ссылки и блоки кода отрисовываются мгновенно, так что вы можете отловить ошибки форматирования до того, как они попадут в коммит.
Написание README и описаний PR
Описания pull request и файлы README часто первое, что читает ревьюер или новый участник проекта. Проверка того, что заголовки, чек-листы и связанные изображения отрисовываются корректно перед отправкой, экономит раунд комментариев «можешь поправить форматирование».
Написание документации офлайн
Написание документации в самолёте или в месте с ненадёжным интернетом не означает отказ от возможности увидеть корректно отрисованное форматирование. Локальный инструмент предпросмотра работает одинаково, подключены вы к сети или нет.