Преобразуване и преглед на Markdown

Табло
Документация
API

преобразува вашия Markdown в HTML и показва преглед на живо, идеален за писане на README файлове, документация или статии

Какво е Markdown?

Markdown е лек език за маркиране, създаден от Джон Грубер през 2004 г. Той позволява да се пише форматиран текст с помощта на прост и четлив в суров вид синтаксис, който след това се преобразува в HTML.

Този инструмент използва спецификацията GFM (GitHub Flavored Markdown), най-разпространеният вариант, който добавя поддръжка на таблици, чекбоксове, кодови блокове със синтактично оцветяване и автоматични връзки.

Прегледът вдясно се обновява в реално време, докато пишете. Бутонът Изпрати генерира съответния HTML код, който можете да копирате или изтеглите.

Основен синтаксис на Markdown

Markdown	Резултат
`# Заглавие 1`	Заглавие <h1>
`## Заглавие 2`	Заглавие <h2>
`удебелен`	удебелен
`курсив`	курсив
`вграден код`	`вграден код`
```php ... ```	Блок с PHP код
`[текст](url)`	Хипервръзка
`![alt](url)`	Изображение
`- елемент`	Неподреден списък
`1. елемент`	Подреден списък
`> цитат`	Blockquote
`---`	Хоризонтален разделител

Често срещани случаи на употреба

GitHub README: писане на документацията на проект с отворен код.
Техническа документация: писане на ръководства, уикита или страници с документация (MkDocs, Docusaurus, Hugo).
Статии в блог: повечето CMS системи (Jekyll, Ghost, Contentful) приемат Markdown.
Коментари и задачи: GitHub, GitLab, Jira, Notion и Slack поддържат GFM.
Форматирани имейли: преобразуване на Markdown в HTML за вграждане в HTML имейл.
Бележки и презентации: Obsidian, Notion, Marp и Reveal.js използват Markdown.

Често задавани въпроси

Каква е разликата между стандартния Markdown и GFM?

Стандартният Markdown (CommonMark) покрива основните елементи: заглавия, списъци, връзки, код. GFM (GitHub Flavored Markdown) добавя таблици, списъци със задачи (- [ ] елемент), ограден код с език (```php), споменавания и автоматични връзки. Този инструмент използва GFM чрез библиотеката league/commonmark.

Сигурен ли е генерираният HTML?

Да. Конверторът е конфигуриран да премахва суровите HTML тагове (html_input: strip) и да блокира несигурните връзки, което предотвратява XSS атаки. Произведеният HTML е подходящ за вграждане в съществуваща уеб страница.

Мога ли да включа HTML в моя Markdown?

От съображения за сигурност суровият HTML, вмъкнат в Markdown, се премахва при преобразуването. Ако се нуждаете от персонализиран HTML резултат, напишете директно целевия HTML.

Какъв е максималният размер на документа?

Няма строго ограничение от страна на сървъра за този инструмент. За много дълги документи (повече от няколко хиляди реда) прегледът в реално време може да се забави в зависимост от вашия браузър.

Пример за заявка

curl -X POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute \
  -H "Content-Type: application/json" \
  -d '{"input":"..."}'

Входна схема

Поле	Тип	Задължително	По подразбиране
`input`	text		–

Крайни точки

GET https://cdrn.fr/api/v1/tools - изброява всички достъпни инструменти
GET https://cdrn.fr/api/v1/tools/markdown-formatter - извлича схемата на този инструмент
POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute - изпълнява този инструмент с JSON payload