Вхідних даних ще немає.
Форматування Markdown із перевіркою рендерингу
Цей інструмент форматування Markdown переписує документ в одному послідовному стилі — маркери, заголовки, нумеровані списки, відступи, таблиці й порожні рядки — і потім перевіряє, що HTML після рендерингу лишився тим самим. Вставте Markdown і завантажте впорядковану версію.
Оновлено:
Як це працює
Вставте Markdown
Вставте текст, відкрийте файл .md або отримайте його за URL. Приклад — навмисно неохайний changelog.
Виберіть стиль
Задайте символ маркера, нумерацію, маркери виділення, огородження коду та спосіб розриву рядків. Кожен параметр може й зберегти оригінальний варіант.
Перегляньте й завантажте
Порівняйте відформатований текст, подивіться на вкладці «Зміни», що змінилося, і на результат перевірки рендерингу, а потім скопіюйте чи завантажте файл.
Можливості
Доказ, що нічого не втрачено
Вхідний текст і результат обробляються парсером CommonMark, а отриманий HTML порівнюється. Зелена позначка означає, що змінилося лише оформлення вихідного тексту.
Правильні списки
Один символ маркера, послідовні номери в нумерованих списках і вкладені пункти з відступом під текстом батьківського пункту. Список з іншим маркером лишається окремим списком.
Вирівняні таблиці
Вертикальні риски стоять рівно, клітинки доповнено пробілами, а рядок вирівнювання зберігає :--, :-: і --: як було.
Заголовки й лінії
Підкреслені заголовки стають заголовками з #, зайві пробіли й закривні # прибираються, а лінії *** чи ___ замінюються на ---.
Код не зачіпається
Огороджені блоки коду й блоки з відступом, блоки HTML і front matter копіюються як є.
Щоразу той самий результат
Форматування детерміноване та ідемпотентне: повторний запуск на результаті нічого не змінює.
Обмеження та конфіденційність
Документи розміром до 5 MB. Форматування й перевірка рендерингу виконуються у вашому браузері (великі вхідні дані — у фоновому потоці Web Worker); текст не надсилається на сервер і ніде не зберігається. Докладніше — на сторінці конфіденційності.
Часті запитання
Як відформатувати файл Markdown?
Вставте текст або перетягніть файл .md, залиште стиль за замовчуванням і завантажте результат. На вкладці «Зміни» видно, скільки фрагментів переписано.
Чи зміниться вигляд мого README?
Ні. Перевірка рендерингу порівнює HTML до і після. Змінюються лише пробіли, маркери й вирівнювання у вихідному тексті.
Чому «#Заголовок» не стає заголовком?
Без пробілу після # CommonMark і GitHub показують такий рядок як текст. Якби його перетворили на заголовок, змінився б сам документ, тому його не чіпають.
Що краще для маркерів: * чи -?
Обидва відображаються однаково. Дефіс найчастіше радять посібники зі стилю та лінтери; виберіть один і дотримуйтеся його.
Що робить «Упорядкувати порожні рядки»?
Кілька порожніх рядків поспіль зводяться до одного, а навколо заголовків, блоків коду й таблиць додаються порожні рядки, яких потребують деякі рендерери.
Це те саме, що Prettier чи markdownlint?
Інструмент охоплює поширені правила форматування цих утиліт без встановлення й додає наочну перевірку рендерингу. Формулювань і посилань він не перевіряє.