Як користуватися
- Введіть Markdown у редакторі або натисніть «Спробувати приклад», щоб завантажити документ із таблицями та списком завдань.
- Стежте, як оновлюється попередній перегляд під час введення. Перемкніться на «HTML-код», щоб побачити згенеровану розмітку.
- Увімкніть або вимкніть GitHub Flavored Markdown чи переноси одиничних рядків відповідно до місця публікації тексту.
- Скопіюйте HTML у CMS або електронний лист чи завантажте результат як файл .html або .md.
Як це працює
Markdown перетворюється за допомогою marked — популярного парсера з відкритим кодом, який підтримує специфікацію CommonMark, а з увімкненою опцією GFM — також GitHub Flavored Markdown: таблиці з роздільниками-вертикальними рисками та вирівнюванням стовпців, списки завдань, ~~закреслення~~ й автоматичне перетворення звичайних URL на посилання. Виноски, математичні формули й діаграми Mermaid не входять до цих специфікацій і відображаються як звичайний текст.
Markdown може містити необроблений HTML, який, як і в більшості засобів відображення Markdown, залишається без змін. Щоб убезпечити вас, попередній перегляд не вставляється безпосередньо на цю сторінку. Він відображається в ізольованому фреймі, якому заборонено запускати скрипти, надсилати форми, відкривати спливні вікна чи отримувати доступ до цього сайту. Політика безпеки вмісту блокує скрипти, зовнішні таблиці стилів, шрифти й фрейми. Тег <script> або атрибут onclick у вашому Markdown відображається в HTML-коді, але не виконується. Посилання в попередньому перегляді видно, але вони не відкриваються; щоб перейти за посиланням, скопіюйте URL.
У попередньому перегляді використовується нейтральна таблиця стилів, подібна до тих, що застосовуються для README. Ваш сайт або GitHub можуть оформити той самий HTML інакше. Скопійований HTML — це фрагмент без стилів; до завантаженого файлу .html додається базова таблиця стилів, щоб він виглядав як у попередньому перегляді. Завантажений або скопійований HTML не очищується від небезпечного коду, тож скрипти в ньому запускатимуться там, куди ви його вставите або де відкриєте.
Приклади
Перевірка README перед відправленням змін
Вставте README.md, щоб перевірити вирівнювання стовпців таблиці, відображення списку завдань як прапорців і правильне оформлення блоків коду перед завантаженням файла на GitHub.
Створення матеріалів для CMS із підтримкою HTML
Створіть чернетку допису в блозі у форматі Markdown, натисніть «Скопіювати HTML» і вставте розмітку <h2>, <p> та <ul> у HTML-редактор CMS.
Переноси рядків у стилі чату
У тексті з чату рядки розділені одиничними переносами рядка. Увімкніть «Вважати одиничні переноси рядка тегом <br>», щоб рядки залишалися окремими, а не зливалися в один абзац.
Поширені запитання
Чи безпечно вставляти Markdown із невідомого джерела?
Так, для попереднього перегляду. Перетворений HTML відображається в ізольованому фреймі з вимкненими скриптами, тож навіть тег <script> або обробник подій у тексті тут нічого не зробить. Будьте обережні, вставляючи експортований HTML, оскільки він не очищується від небезпечного коду.
Чому мої зображення не відображаються?
Зображення з інших сайтів за замовчуванням заблоковано, щоб попередній перегляд не надсилав мережевих запитів. Увімкніть «Завантажувати зображення з інших сайтів», щоб показати їх. Відносні шляхи на кшталт ./docs/screenshot.png не працюватимуть, оскільки цих файлів тут немає.
Чи підтримуються виноски, формули та діаграми?
Ні. Підтримуються CommonMark і GitHub Flavored Markdown (таблиці, списки завдань, закреслення, автоматичні посилання). Виноски, формули LaTeX і діаграми Mermaid — це розширення, які в цьому попередньому перегляді відображаються як звичайний текст.
Чому одиничний перенос рядка не починає новий рядок?
У стандартному Markdown одиничний перенос рядка в абзаці вважається пробілом. Додайте в кінці рядка два пробіли, залиште порожній рядок або ввімкніть «Вважати одиничні переноси рядка тегом <br>».
Конфіденційність
Markdown перетворюється у вашому браузері, не завантажується на сервер і не зберігається. Попередній перегляд не завантажує нічого з інтернету, якщо ви не дозволите показувати зображення з інших сайтів; у такому разі зображення запитуються безпосередньо з їхніх джерел.