Памятка - Markdown в стиле GitHub

Чит-лист - Markdown в стиле GitHub

2023-12-12

GitHub Flavored Markdown (GFM) расширяет стандартный синтаксис Markdown, добавляя несколько дополнительных функций, специфичных для GitHub. Этот шпаргалка охватывает ключевые аспекты GFM, упрощая создание README, задач и другой документации на GitHub.

Расширенный синтаксис

Списки задач

Создайте списки задач с - [ ] для незавершенной задачи и - [x] для завершенной задачи.
```
-   [x] Завершенная задача
-   [ ] Незаполненная задача
```

Зачеркивание

Используйте двойные тильды ~~ для зачеркивания текста.
```
~~Зачеркивание~~
```

Таблицы

Создавайте таблицы, используя дефисы - и вертикальные черты |.

| Заголовок 1 | Заголовок 2 |
| -------- | -------- |
| Строка 1    | Данные 1   |
| Строка 2    | Данные 2   |

Замкнутые блоки кода

Используйте тройные обратные кавычки (```) и укажите язык для подсветки синтаксиса.

```javascript console.log("Привет, мир!"); ```

Упоминание пользователей и команд

Используйте @username для упоминания пользователя или команды.

Ссылки на задачи и запросы на внесение изменений

Упоминайте задачи и запросы на внесение изменений, используя #.

Стандартный синтаксис Markdown

Заголовки

Используйте # для заголовков. Больше #s означает меньшие заголовки.

Форматирование текста

Жирный: **жирный**
Курсив: *курсив*
Жирный и курсив: ***жирный & курсив***

Списки

Несортированный список: Начните с -, + или *.
Упорядоченный список: Начните с цифр, за которыми следует ..

Ссылки и изображения

Ссылка: [Заголовок](URL)
Изображение: ![Alt текст](URL)

Цитаты

Используйте > для блочных цитат.

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