Ключевые факты
- Категория
- Преобразование и кодирование
- Типы входных данных
- textarea, checkbox
- Тип результата
- json
- Покрытие примерами
- 4
- API доступен
- Yes
Обзор
Этот инструмент позволяет быстро преобразовать стандартный Markdown в формат разметки Slack mrkdwn. Он автоматически адаптирует заголовки, списки, ссылки и блоки кода, а также находит и помечает элементы, которые Slack не поддерживает (например, таблицы или списки задач), помогая подготовить текст для отправки в чат без ошибок форматирования.
Когда использовать
- •При публикации логов изменений (changelog) или релиз-нот из репозитория GitHub напрямую в каналы Slack.
- •При настройке интеграций и вебхуков, отправляющих отформатированные текстовые сообщения в Slack.
- •При необходимости быстро перенести документацию или инструкции из Markdown-файлов в рабочие чаты Slack с сохранением структуры.
Как это работает
- •Вставьте исходный текст в формате Markdown в текстовое поле ввода.
- •Включите опцию «Помечать неподдерживаемые элементы», чтобы выявить несовместимые структуры, такие как таблицы или чек-листы.
- •Запустите конвертацию для генерации JSON-ответа, содержащего готовый текст mrkdwn и список неподдерживаемых элементов.
- •Скопируйте полученный текст mrkdwn для отправки через API Slack или вручную в клиент.
Сценарии использования
Примеры
1. Конвертация заметок к релизу
Релиз-инженер- Контекст
- Инженер готовит описание новой версии приложения, написанное в Markdown для GitHub, чтобы опубликовать его в канале оповещений Slack.
- Проблема
- Необходимо быстро перевести разметку заголовков и списков в формат mrkdwn и убедиться, что в тексте нет неподдерживаемых элементов вроде чек-листов.
- Как использовать
- Вставьте текст релиза в поле Markdown, активируйте опцию пометки неподдерживаемых элементов и запустите конвертацию.
- Пример конфигурации
-
markdown: '# Release 1.2.0\n- [ ] Fix bug\n- Add feature', annotateUnsupported: true - Результат
- Получен JSON с mrkdwn-текстом '*Release 1.2.0*\n• [ ] Fix bug\n• Add feature' и предупреждением о наличии неподдерживаемого элемента 'task-list'.
2. Подготовка сообщения для вебхука Slack
DevOps-специалист- Контекст
- Специалист настраивает оповещения о сбоях в системе мониторинга, которая выдает отчеты в формате Markdown.
- Проблема
- Сообщения в Slack приходят в сыром виде с неработающими ссылками и некорректными блоками кода.
- Как использовать
- Скопируйте шаблон отчета мониторинга, вставьте в конвертер и отключите пометку неподдерживаемых элементов, если структура простая.
- Пример конфигурации
-
markdown: '### Alert\nError in `auth-service`. [Details](http://example.com)', annotateUnsupported: false - Результат
- Сгенерирован чистый mrkdwn-текст '*Alert*\nError in `auth-service`. <http://example.com|Details>', готовый для отправки через входящий вебхук.
Проверить на примерах
markdownСвязанные хабы
FAQ
Какие элементы Markdown не поддерживаются в Slack mrkdwn?
Slack не поддерживает таблицы, списки задач (task lists), изображения внутри текста и некоторые уровни заголовков.
Зачем нужна опция «Помечать неподдерживаемые элементы»?
Она помогает быстро найти элементы, которые не отобразятся в Slack, чтобы вы могли переписать их вручную перед отправкой.
Как Slack mrkdwn обрабатывает заголовки?
Заголовки преобразуются в жирный текст, так как Slack не поддерживает стандартные теги заголовков разного размера.
Можно ли использовать этот инструмент для подготовки сообщений для Slack API?
Да, инструмент возвращает JSON с готовой строкой mrkdwn, которую можно сразу вставлять в тело запроса к API Slack.
Поддерживаются ли ссылки и блоки кода?
Да, стандартные ссылки Markdown и блоки кода (code blocks) корректно конвертируются в синтаксис Slack.