Генератор блоков кода Markdown
Оберните код в блок кода Markdown с нужным языком для подсветки синтаксиса, выберите ограждение и при желании сделайте его сворачиваемым.
Загрузка: Генератор блоков кода Markdown…
Ваши файлы не покидают устройство
Как пользоваться: Генератор блоков кода Markdown
- 1
Откройте «Генератор блоков кода Markdown» на этой странице. Инструмент загружается прямо в браузере.
- 2
Добавьте файл, текст или значения и настройте параметры.
- 3
Скопируйте или скачайте результат. Ничего не загружается и не хранится.
Об инструменте
Делиться кодом в README, issue на GitHub, в Discord или на Stack Overflow лучше всего в ограждённом блоке кода с указанным языком: так он сохраняет форматирование и получает подсветку синтаксиса. Этот генератор блоков кода Markdown правильно оборачивает код, даже если в нём самом есть обратные апострофы, и умеет прятать длинные фрагменты в сворачиваемый блок.
Как создать блок кода
- Вставьте код.
- Выберите язык, например JavaScript, Python, Bash, JSON или SQL.
- Выберите ограждение: три обратных апострофа или тильды, если в коде есть обратные апострофы.
- При желании включите сворачиваемый блок и напишите его заголовок.
- Проверьте предпросмотр и скопируйте Markdown.
Что получается
```python
print("Hello")
```
Название языка после открывающего ограждения подсказывает GitHub, GitLab, Discord и инструментам документации, как раскрасить код.
Сворачиваемый код
Длинные логи и файлы конфигурации могут заслонить остальную часть issue. Сворачиваемый вариант оборачивает блок в элемент details с вашим заголовком, например «Полный лог ошибки», и читатели раскроют его, когда понадобится.
Советы
- Всегда указывайте язык: код читается гораздо легче.
- Используйте diff как язык, чтобы показать добавленные и удалённые строки знаками + и -.
- Сокращайте длинный вывод до нужной части перед публикацией.
- Удаляйте секреты, например API ключи и пароли, из кода перед публикацией.
Больше о Markdown в шпаргалке по Markdown, а целый документ можно написать в редакторе Markdown.
Частые вопросы
Как добавить блок кода в Markdown?
Поставьте три обратных апострофа на строке до и после кода и напишите название языка сразу после первых трёх, например ```javascript.
Как показать код, в котором есть обратные апострофы?
Используйте более длинное ограждение или тильды (~~~) вокруг блока, генератор может сделать это за вас, чтобы внутренние апострофы не закрыли блок.
Какие языки подсвечиваются?
Подсветку делает сайт, который показывает ваш Markdown. GitHub, GitLab и большинство инструментов поддерживают распространённые языки, такие как JavaScript, Python, Bash, JSON и SQL.
Как сделать сворачиваемый блок кода?
Включите сворачиваемый вариант и введите заголовок. Блок будет обёрнут в элемент details, который читатели смогут раскрыть.
Как показать diff?
Укажите diff как язык и начинайте изменённые строки с + или -. На GitHub они показываются зелёным и красным.
Работает ли это в Discord и Slack?
Discord поддерживает ограждённые блоки кода с языком. Slack поддерживает блоки кода, но без подсветки по языку.