Создание и выделение блоков кода

Предоставляйте общий доступ к примерам кода с изолированными блоками кода и включайте выделения синтаксиса.

Кто может использовать эту функцию?

Markdown можно использовать в веб-интерфейсе GitHub .

В этой статье

Огороженные блоки кода

Чтобы создать блок кода с ограждением, можно поместить блок кода между тремя обратными штрихами ```. Рекомендуется оставлять пустую строку до блока кода и после него для удобства чтения.

```
function test() {
  console.log("notice the blank line before this function?");
}
```

Снимок экрана: отрисованный GitHub Markdown, показывающий использование тройных обратных шаблонов для создания блоков кода. Блок начинается с "function test() {".

Совет

Чтобы сохранить форматирование в списке, обязательно отступ не огороженный блок кода на восемь пробелов.

Чтобы показать три обратных штриха в блоке кода с ограждением, заключите их в четыре обратных штриха.

````
```
Look! You can see my backticks.
```
````

Снимок экрана: отрисованный Markdown, показывающий, что при записи тройных обратных символов между четырехкратными обратными знаками они отображаются в отрисованном содержимом.

Если вы часто редактируете фрагменты кода и таблицы, вы можете воспользоваться включением шрифта фиксированной ширины во всех полях комментариев на GitHub. Дополнительные сведения см. в разделе О написании и форматировании на GitHub.

Выделение синтаксиса

Чтобы включить выделение синтаксических конструкций в блоке кода с ограждением можно добавить необязательный идентификатор языка.

Выделение синтаксиса изменяет цвет и стиль исходного кода, чтобы упростить чтение.

Например, так можно задать выделение синтаксических конструкций Ruby:

```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```

Откроется блок кода с выделением синтаксиса:

Снимок экрана: три строки кода Ruby, отображаемые на GitHub. Элементы кода, отображаемые в фиолетовом, синем и красном типах для проверки.

Совет

Когда вы создаёте ограниченный блок кода, который также хотите выделить синтаксисом на сайте GitHub Pages, используйте строчные языковые идентификаторы. Дополнительные сведения см. в разделе О страницах GitHub и Jekyll.

Мы используем библиотеку Linguist для определения языка и выбора сторонних грамматик для выделения синтаксических конструкций. Ознакомиться со списком допустимых ключевых слов можно в YAML-файле языков.

Создание схем

С помощью блоков кода также можно создавать схемы в Markdown. GitHub поддерживает синтаксис Mermaid, GeoJSON, TopoJSON и ASCII STL. Дополнительные сведения см. в разделе Создание схем.

Дополнительные материалы

  •         [Спецификация GitHub Flavored Markdown](https://github.github.com/gfm/)

  •         [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)