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

Метод 1: встроенный код
Самый простой способ выделить код в GitHub Markdown — использовать встроенное форматирование кода. Заключите код в обратные кавычки (`). Например:

Use the `print()` function to display the output.

Метод 2: изолированные блоки кода
Для больших фрагментов кода или нескольких строк кода лучше использовать изолированные блоки кода. Начинайте и заканчивайте блок кода тремя обратными кавычками («`). При необходимости укажите язык программирования, чтобы включить подсветку синтаксиса. Например:

“`python
defsay_hello():
print(“Привет, мир!”)
“`

Метод 3: подсветка синтаксиса Markdown со вкусом GitHub (GFM)
GitHub поддерживает подсветку синтаксиса для широкого спектра языков программирования. Чтобы включить подсветку синтаксиса, укажите язык после первых трех обратных кавычек. Например:

“`javascript
const message = “Привет, мир!”;
console.log(message);
“`

Метод 4: переопределение языка Linguist
Библиотека Linguist на GitHub автоматически определяет язык программирования в блоке кода. Однако, если Linguist не сможет определить правильный язык, вы можете переопределить его вручную. Используйте префикс language-, за которым после первых трех обратных кавычек следует название языка. Например:

“`language-bash
echo “Привет, мир!”
“`

Метод 5: службы внешних фрагментов кода
GitHub Markdown также позволяет встраивать фрагменты кода из внешних служб, таких как Gist или CodePen. Например, чтобы встроить Gist:

“`gist
имя пользователя/gist_id
“`

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