Як написати блок коду в Markdown:огородіть його трьома зворотними лапками.

Блоки коду з огородженням

Огородження — це рядок щонайменше з трьох зворотних лапок, а блок закінчується рядком не коротшим за відкривний. Усе між ними показується як набрано: без напівжирного, без посилань, без склеювання рядків.

```
plain text, no colors
  indentation is kept
```

Замість цього можна взяти три тильди: ~~~ відкриває, ~~~ закриває. Ці два види не змішуються: блок, відкритий тильдами, має закриватися тильдами. Блок коду вийде й за відступу кожного рядка на чотири пробіли — це старий стиль, але в ньому не можна вказати мову, тому огородження кращі.

Теги мови та підсвічування синтаксису

Слово після відкривного огородження називається info string. Більшість застосунків за ним обирають підсвічування:

```json
{ "name": "dotmd", "private": true }
```

Поширені назви, що працюють на GitHub, у DotMD і в більшості інших застосунків:

• js або javascript, ts або typescript, python, swift, go, rust
• bash, sh або zsh для команд оболонки
• json, yaml, html, css, sql
• markdown або md, щоб показати сам Markdown, diff для змін, text — без кольорів

Точний список назв залежить від застосунку та його підсвічування. Назва, якої застосунок не знає, не помилка: блок просто показується без кольорів. Блок без мови теж показується без підсвічування.

Зворотні лапки всередині блоку коду

Якщо в коді є рядок із трьох зворотних лапок, огородіть блок довшим огородженням. Закривне огородження має бути не коротшим за відкривне, тому щоб показати три, візьміть чотири:

````markdown
```swift
let x = 1
```
````

Саме так на цій сторінці показано приклади Markdown із блоками коду. З огородженням із тильд те саме: блок, відкритий ~~~~, може містити ~~~.

Рядковий код

Для команди чи імені всередині речення візьміть їх в одинарні зворотні лапки: `npm install` дає npm install. Щоб показати зворотну лапку, візьміть усе в подвійні зворотні лапки й додайте пробіл усередині, якщо код починається чи закінчується зворотною лапкою:

``a `tick` inside``

Рядковий код ще й не дає символам на кшталт * і _ сприйматися як розмітка, тому він підходить для імен файлів і змінних.

Код у списках і цитатах

Блок з огородженням може стояти всередині пункту списку. Зсуньте огородження так, щоб воно збігалося з текстом пункту, і воно лишиться частиною пункту:

1. Install the tool:

   ```bash
   brew install example
   ```

2. Run it.

Поставте порожній рядок перед огородженням і зсувайте всі рядки коду на однакову величину. У цитаті починайте кожен рядок огородження з >.

Блоки diff

Позначте блок як diff, і рядки, що починаються з + або -, отримають зелений і червоний кольори в застосунках, які підсвічують diff, зокрема на GitHub:

```diff
- let timeout = 30
+ let timeout = 60
```

Це зручний спосіб показати зміну в документації, README чи специфікації без скриншотів.

Часті помилки

• Закривне огородження коротше за відкривне, через що блок не закінчується й поглинає решту сторінки.
• Пробіли перед тегом мови в суворих застосунках. Якщо кольори не з'явилися, пишіть ```js, а не ``` js.
• Зворотні лапки й тильди в одному блоці.
• Немає порожнього рядка перед огородженням після пункту списку чи абзацу в деяких застосунках. Додайте його.
• Фігурні лапки. Текст, вставлений із текстового редактора, може перетворити прямі лапки в коді на фігурні. Вставляйте як простий текст.

Не всі огородження потрібні, щоб показати код. Блок із позначкою mermaid GitHub і DotMD малюють як діаграму, якщо синтаксис правильний.

Перевірка кольорів

Найшвидше тег мови перевіряється в програмі для читання. DotMD підсвічує блоки з огородженням через highlight.js у світлій і темній темах та показує кнопку Copy при наведенні на блок. Читання безкоштовне, а решту синтаксису зібрано на одній сторінці в шпаргалці з Markdown.

Питання про блоки коду в Markdown

Інші запитання