# Базовый синтаксис написания и форматирования
Создайте сложное форматирование для своей прозы и кода на GitHub с простым синтаксисом.
## Заголовки
Чтобы создать заголовок, добавьте от одного до шести # символов перед текстом заголовка. Количество # используемых вами шрифтов будет определять уровень иерархии и размер шрифта заголовка.
```markdown
# A first-level heading
## A second-level heading
### A third-level heading
```
Когда вы используете два или более заголовков, GitHub автоматически генерирует оглавление, к которому можно получить доступ, нажав на иконку меню «Outline» в заголовке файла. Каждый заголовок указан в оглавлении, и вы можете нажать на заголовок, чтобы перейти к выбранному разделу.
## Стилизация текста
Выделение можно выделить жирным, курсивом, зачеркнутым, подстрочным или надстрочным текстом в полях комментариев и `.md` файлах.
| Style | Синтаксис | Сочетание клавиш | Example | Выходные данные |
| ----- | --------- | ---------------- | ------- | --------------- |
| Bold | | | | |
```
`** **` или `__ __`|
Command+B (Mac) или Ctrl+B (Windows/Linux) | `**This is bold text**` |
**Это жирный текст** |
```
\| Курсив |
`* *` или `_ _` | Command+I (Mac) или Ctrl+I (Windows/Linux) | `_This text is italicized_` |
*Этот текст выделен курсивом* |
\| Зачеркнутый |
`~~ ~~` или `~ ~` | None | `~~This was mistaken text~~` |
~~Это был ошибочный текст~~ |
\| Полужирный и вложенный курсив |
`** **` и `_ _`. | None | `**This text is _extremely_ important**` |
**Этот текст *чрезвычайно* важен** |
\| Все жирным шрифтом и курсивом | `*** ***` | None | `***All this text is important***` |
***Весь этот текст важен*** |
\| Подстрочный | `` | None | `This is a subscript text` | Это подстрочный текст |
\| Надстрочный | `` | None | `This is a superscript text` | Это надстрочный текст |
\| Подчеркивание | ` ` | None | `This is an underlined text` | Это подчеркнутый текст |
## Цитирование текста
Вы можете цитировать текст с помощью >.
```markdown
Text that is not a quote
> Text that is a quote
```
Текст в кавычках имеет отступ в виде вертикальной линии слева и отображается серым шрифтом.
> \[!NOTE]
> При просмотре беседы вы можете автоматически цитировать текст в комментарии, выделив текст, а затем набрав R. Вы можете процитировать весь комментарий, нажав , затем **ответить на цитату**. Дополнительные сведения о сочетаниях клавиш см. [в разделе АВТОЗАГОЛОВОК](/ru/get-started/accessibility/keyboard-shortcuts).
## Код кавычек
Вы можете вызвать код или команду в предложении с помощью одинарных обратных кавычек. Текст в обратных кавычках не будет отформатирован. Также можно нажать Command+E (Mac) или Ctrl+E (Windows/Linux), чтобы вставить бэктики для кодового блока в строку Markdown.
```markdown
Use `git status` to list all new or modified files that haven't yet been committed.
```
Чтобы отформатировать код или текст в отдельный блок, используйте тройные обратные кавычки.
````markdown
Some basic Git commands are:
```
git status
git add
git commit
```
````
Дополнительные сведения см. в разделе [Создание и выделение блоков кода](/ru/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks).
Если вы часто редактируете фрагменты кода и таблицы, вы можете воспользоваться включением шрифта фиксированной ширины во всех полях комментариев на GitHub. Дополнительные сведения см. в разделе [О написании и форматировании на GitHub](/ru/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github#enabling-fixed-width-fonts-in-the-editor).
## Поддерживаемые цветовые модели
В задачах, запросах на вытягивание и обсуждениях вы можете вызывать цвета в предложении с помощью обратных кавычек. Поддерживаемая цветовая модель в обратных кавычках будет отображать визуализацию цвета.
```markdown
The background color is `#ffffff` for light mode and `#000000` for dark mode.
```
Ниже приведены поддерживаемые в настоящее время цветовые модели.
| Цвет | Синтаксис | Example | Выходные данные |
| ------------ | --------------------------- | ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ЗАЧАРОВЫВАТЬ | \`#RRGGBB\` | \`#0969DA\` |  |
| RGB | \`rgb(R,G,B)\` | \`rgb(9, 105, 218)\` |  |
| HSL | \`hsl(H,S,L)\` | \`hsl(212, 92%, 45%)\` |  |
> \[!NOTE]
>
> * Поддерживаемая цветовая модель не может содержать начальных или конечных пробелов в обратных кавычках.
> * Визуализация цвета поддерживается только в задачах, запросах на вытягивание и обсуждениях.
## Links
Вы можете создать встроенную ссылку, заключив текст ссылки в квадратные `[ ]`скобки, а затем обернув URL-адрес в скобки `( )`. Вы также можете использовать сочетание клавиш Command+K для создания ссылки. Когда текст выделен, вы можете вставить URL-адрес из буфера обмена, чтобы автоматически создать ссылку из выделенного.
Вы также можете создать гиперссылку Markdown, выделив текст и используя сочетание клавиш Command+V. Если вы хотите заменить текст ссылкой, используйте сочетание клавиш Command+Shift+V.
`This site was built using [GitHub Pages](https://pages.github.com/).`
> \[!NOTE]
> GitHub автоматически создает ссылки, когда в комментарии прописаны действительные URL. Дополнительные сведения см. в разделе [Автосвязанные ссылки и URL-адреса](/ru/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls).
## Ссылки на разделы
Вы можете связаться непосредственно с любым разделом с заголовком. Чтобы просмотреть автоматически созданную привязку в отрисованном файле, наведите указатель мыши на заголовок раздела, чтобы предоставить значок и щелкните значок, чтобы отобразить привязку в браузере.
Если вам нужно определить якорь для заголовка в редактируемом файле, вы можете воспользоваться следующими основными правилами:
* Буквы преобразуются в строчные буквы.
* Пробелы заменяются дефисами (`-`). Любые другие пробелы или знаки препинания удаляются.
* Начальные и конечные пробелы удаляются.
* Форматирование разметки удаляется, оставляя только содержимое (например, `_italics_` становится `italics`).
* Если автоматически созданная привязка для заголовка идентична более ранней привязке в том же документе, уникальный идентификатор создается путем добавления дефиса и автоматически увеличивающегося целого числа.
Для получения более подробной информации о требованиях к фрагментам URI см. [RFC 3986: Uniform Resource Identifier (URI): Generic Syntax, раздел 3.5](https://www.rfc-editor.org/rfc/rfc3986#section-3.5).
В приведенном ниже блоке кода демонстрируются основные правила, используемые для создания якорей из заголовков в отрисованном содержимом.
```markdown
# Example headings
## Sample Section
## This'll be a _Helpful_ Section About the Greek Letter Θ!
A heading containing characters not allowed in fragments, UTF-8 characters, two consecutive spaces between the first and second words, and formatting.
## This heading is not unique in the file
TEXT 1
## This heading is not unique in the file
TEXT 2
# Links to the example headings above
Link to the sample section: [Link Text](#sample-section).
Link to the helpful section: [Link Text](#thisll-be-a-helpful-section-about-the-greek-letter-Θ).
Link to the first non-unique section: [Link Text](#this-heading-is-not-unique-in-the-file).
Link to the second non-unique section: [Link Text](#this-heading-is-not-unique-in-the-file-1).
```
> \[!NOTE]
> Если вы редактируете заголовок или изменяете порядок заголовков с «идентичными» якорями, вам также потребуется обновить все ссылки на эти заголовки, поскольку якоря будут меняться.
## Относительные ссылки
Вы можете определить относительные ссылки и пути к изображениям в отображаемых файлах, чтобы читателям было проще переходить к другим файлам в репозитории.
Относительная ссылка — это ссылка, заданная относительно текущего файла. Например, если есть файл сведений в корне репозитория и еще один файл в *docs/CONTRIBUTING.md*, относительная ссылка на *CONTRIBUTING.md* в файле сведений может выглядеть следующим образом:
```text
[Contribution guidelines for this project](docs/CONTRIBUTING.md)
```
GitHub автоматически преобразует относительную ссылку или путь изображения на основе любой ветви, в которую вы находитесь в данный момент, чтобы ссылка или путь всегда работали. Путь ссылки будет относительным к текущему файлу. Ссылки, начинающиеся с `/`, будут относительными к корневому каталогу репозитория. Можно использовать любые операнды относительных ссылок, например `./` и `../`.
Текст ссылки должен находиться в одной строке. Приведенный ниже пример не будет работать.
```markdown
[Contribution
guidelines for this project](docs/CONTRIBUTING.md)
```
Относительные ссылки удобнее для пользователей, которые клонируют репозиторий. Абсолютные ссылки могут не работать в клонах репозитория. Мы рекомендуем использовать относительные ссылки на другие файлы в репозитории.
## Пользовательские якоря
Вы можете использовать стандартные теги привязки HTML (``) для создания опорных точек навигации для любого места в документе. Чтобы избежать неоднозначных ссылок, используйте уникальную схему именования для тегов привязки, например добавьте префикс к значению атрибута `name` .
> \[!NOTE]
> Пользовательские привязки не будут включены в структуру документа/оглавление.
Вы можете создать ссылку на пользовательский якорь, используя значение атрибута, который `name` вы ему присвоили. Синтаксис точно такой же, как и при ссылке на якорь, который автоматически создается для заголовка.
Рассмотрим пример.
```markdown
# Section Heading
Some body text of this section.
Some text I want to provide a direct link to, but which doesn't have its own heading.
(… more content…)
[A link to that custom anchor](#my-custom-anchor-point)
```
> \[!TIP]
> Пользовательские привязки не учитываются автоматическим именованием и нумерацией автоматических ссылок на заголовки.
## Разрывы строк
Если вы пишете в проблемах, запросах на вытягивание или обсуждениях в репозитории, GitHub автоматически отобразит перенос строки:
```markdown
This example
Will span two lines
```
Однако, если вы пишете в файле .md, приведенный выше пример будет отображаться на одной строке без переноса строки. Чтобы создать перенос строки в файле .md, вам потребуется включить одно из следующих элементов:
* Добавьте два пробела в конце первой строки.
This example
Will span two lines
* Добавьте обратную косую черту в конце первой строки.
```markdown
This example\
Will span two lines
```
* Добавьте тег разрыва одной строки в HTML в конце первой строки.
```markdown
This example
Will span two lines
```
Если вы оставите пустую строку между двумя строками, оба файла .md и Markdown в задачах, запросах на вытягивание и обсуждениях отобразят две строки, разделенные пустой строкой:
```markdown
This example
Will have a blank line separating both lines
```
## Изображения
Вы можете отобразить изображение, добавив ! и перенеся альтернативный текст в .`[ ]` Альтернативный текст — это короткий текстовый эквивалент информации на изображении. Затем оберните ссылку на изображение в круглые скобки `()`.
``
GitHub поддерживает встраивание изображений в ваши задачи, запросы на вытягивание, обсуждения, комментарии и `.md` файлы. Вы можете отобразить изображение из репозитория, добавить ссылку на изображение в Интернете или отправить изображение. Дополнительные сведения см. в [разделе Загрузка ресурсов](#uploading-assets).
> \[!NOTE]
> Если вы хотите отобразить изображение, которое находится в репозитории, используйте относительные ссылки вместо абсолютных.
Вот несколько примеров использования относительных ссылок для отображения изображения.
| Контекст | Относительная ссылка |
| ------------------------------------------------------------- | ---------------------------------------------------------------------- |
| В файле `.md` на той же ветке | `/assets/images/electrocat.png` |
| В файле `.md` на другой ветке | `/../main/assets/images/electrocat.png` |
| В задачах, запросах на вытягивание и комментариях репозитория | `../blob/main/assets/images/electrocat.png?raw=true` |
| В файле `.md` в другом репозитории | `/../../../../github/docs/blob/main/assets/images/electrocat.png` |
| В задачах, пулл-реквестах и комментариях другого репозитория | `../../../github/docs/blob/main/assets/images/electrocat.png?raw=true` |
> \[!NOTE]
> Последние две относительные ссылки в таблице выше будут работать для изображений в частном репозитории только в том случае, если у зрителя есть хотя бы доступ на чтение к частному репозиторию, содержащему эти изображения.
Для получения дополнительной информации см. [раздел Относительные ссылки](#relative-links).
### Элемент Picture
Поддерживается `` элемент HTML.
## Lists
Вы можете создать неупорядоченный список, начав одну или несколько строк текста с помощью -, \*или +.
```markdown
- George Washington
* John Adams
+ Thomas Jefferson
```
Чтобы упорядочить список, предваряйте каждую строку номером.
```markdown
1. James Madison
2. James Monroe
3. John Quincy Adams
```
### Вложенные списки
Можно создать вложенный список, сделав отступ между одним или несколькими элементами списка.
Чтобы создать вложенный список с помощью веб-редактора на GitHub или текстового редактора, использующего моноширинный шрифт, например [Visual Studio Code](https://code.visualstudio.com/), вы можете выровнять свой список визуально. Вводите символы пробела перед вложенным элементом списка до тех пор, пока символ маркера списка (- или \*) не будет находиться непосредственно под первым символом текста в элементе над ним.
```markdown
1. First list item
- First nested list item
- Second nested list item
```
> \[!NOTE]
> В веб-редакторе можно сделать отступ или отступить одну или несколько строк текста, сначала выделив нужные строки, а затем используя клавиши Tab или Shift+Tab соответственно.
Чтобы создать вложенный список в редакторе комментариев на GitHub, в котором не используется моноширинный шрифт, вы можете посмотреть на элемент списка непосредственно над вложенным списком и посчитать количество символов, которые появляются перед содержимым элемента. Затем введите это количество пробелов перед вложенным элементом списка.
В этом примере можно добавить вложенный элемент списка под элементом `100. First list item` списка, сделав отступ вложенного элемента списка минимум на пять пробелов, так как`100. ` перед `First list item`.
```markdown
100. First list item
- First nested list item
```
С помощью одного и того же метода можно создать несколько уровней вложенных списков. Например, поскольку первый вложенный элемент списка содержит семь символов (`␣␣␣␣␣-␣`) перед содержимым `First nested list item`вложенного списка, вам потребуется сделать отступ второго вложенного элемента списка по крайней мере еще двумя символами (минимум девять пробелов).
```markdown
100. First list item
- First nested list item
- Second nested list item
```
Для дополнительных примеров см. [GitHub Flavored Markdown Spec](https://github.github.com/gfm/#example-265).
## Списки задач
Чтобы создать список задач, добавьте к элементам списка префикс — дефис, пробел, а затем `[ ]`. Чтобы пометить задачу как завершенную, используйте `[x]`.
```markdown
- [x] #739
- [ ] https://github.com/octo-org/octo-repo/issues/740
- [ ] Add delight to the experience when all tasks are complete :tada:
```
Если описание элемента списка задач начинается со скобок, вам нужно будет экранировать его с помощью \\:
`- [ ] \(Optional) Open a followup issue`
Дополнительные сведения см. в разделе [Сведения о списках задач](/ru/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists).
## Упоминание людей и команд
Вы можете упомянуть человека или [команду](/ru/organizations/organizing-members-into-teams) в GitHub, введя @ плюс их имя пользователя или название команды. Это вызовет уведомление и привлечет их внимание к разговору. Пользователи также получат уведомление, если вы измените комментарий, указав их имя пользователя или название команды. Дополнительные сведения о уведомлениях см. в разделе [Об уведомлениях](/ru/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications).
> \[!NOTE]
> Пользователь будет уведомлен об упоминании только в том случае, если у него есть доступ на чтение к репозиторию и, если репозиторий принадлежит организации, он является членом организации.
`@github/support What do you think about these updates?`
Когда вы упоминаете родительскую команду, члены ее дочерних команд также получают уведомления, что упрощает общение с несколькими группами людей. Дополнительные сведения см. в разделе [Сведения о командах организации](/ru/organizations/organizing-members-into-teams/about-teams).
При вводе символа @ появится список людей или команд в проекте. Список фильтруется по мере ввода, поэтому, как только вы найдете имя человека или команды, которых ищете, вы можете выбрать его с помощью клавиш со стрелками и нажать клавишу Tab или Enter, чтобы завершить название. Для команд введите enter, @organization/team-name и все члены этой команды будут подписаны на беседу.
Результаты автозаполнения доступны только участникам репозитория и любым другим участникам потока.
## Ссылки на проблемы и запросы на вытягивание
Вы можете открыть список предложенных проблем и запросов на вытягивание в репозитории, введя #. Введите номер или название проблемы или запроса на вытягивание, чтобы отфильтровать список, а затем нажмите клавишу Tab или Enter, чтобы завершить выделенный результат.
Дополнительные сведения см. в разделе [Автосвязанные ссылки и URL-адреса](/ru/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls).
## Ссылки на внешние ресурсы
Если для репозитория настроены пользовательские автоматические ссылки, то ссылки на внешние ресурсы, такие как проблема JIRA или тикет Zendesk, конвертируются в сокращенные ссылки. Чтобы узнать, какие автоматические ссылки доступны в репозитории, обратитесь к кому-то, у кого есть разрешения администратора в отношении репозитория. Дополнительные сведения см. в разделе [Настройка автоматической привязки для отсылок на внешние ресурсы](/ru/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources).
## Загрузка ресурсов
Вы можете загружать ресурсы, такие как изображения, перетаскивая, выбирая в браузере файлов или вставляя их. Вы можете отправлять ресурсы в проблемы, запросы на вытягивание, комментарии и `.md` файлы в репозитории.
## Использование эмодзи
Вы можете добавить эмодзи к своему тексту, набрав `:EMOJICODE:`, двоеточие с последующим названием эмодзи.
`@octocat :+1: This PR looks great - it's ready to merge! :shipit:`
Ввод : вызовет список предлагаемых эмодзи. Список будет фильтроваться по мере ввода, поэтому, как только вы найдете нужный эмодзи, нажмите **Tab** или **Enter** , чтобы завершить выделенный результат.
Полный список доступных эмодзи и кодов см. [в Шпаргалке по эмодзи](https://github.com/ikatyang/emoji-cheat-sheet/blob/github-actions-auto-update/README.md).
## Абзацы
Вы можете создать новый абзац, оставив пустую строку между строками текста.
## Сноски
Вы можете добавить сноски к своему содержимому, используя следующий синтаксис квадратных скобок:
```text
Here is a simple footnote[^1].
A footnote can also have multiple lines[^2].
[^1]: My reference.
[^2]: To add line breaks within a footnote, add 2 spaces to the end of a line.
This is a second line.
```
Сноска будет выглядеть следующим образом:
> \[!NOTE]
> Положение сноски в Markdown не влияет на то, где будет отображаться сноска. Вы можете написать сноску сразу после ссылки на сноску, и сноска все равно будет отображаться в нижней части Markdown. Сноски не поддерживаются в вики.
## Уведомления
```
**Оповещения**, также иногда называемые **выносками** или **предупреждениями**, представляют собой расширение Markdown, основанное на синтаксисе цитат, которое можно использовать для выделения важной информации. На GitHub они отображаются с отличительными цветами и значками, указывающими на важность контента.
```
Используйте оповещения только в том случае, если они имеют решающее значение для успеха пользователя, и ограничьте их одним или двумя на статью, чтобы не перегружать читателя. Кроме того, вы должны избегать последовательного размещения оповещений. Оповещения не могут быть вложены в другие элементы.
Чтобы добавить алерт, используйте специальную строку в виде цитаты, указывающую тип алерта, за которой следует информация об алерте в стандартной цитате блока. Доступно пять типов оповещений:
```markdown
> [!NOTE]
> Useful information that users should know, even when skimming content.
> [!TIP]
> Helpful advice for doing things better or more easily.
> [!IMPORTANT]
> Key information users need to know to achieve their goal.
> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.
> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.
```
Ниже приведены отображаемые предупреждения:
## Скрытие содержимого с комментариями
Вы можете указать GitHub, чтобы скрыть содержимое от отображаемого Markdown, поместив содержимое в HTML-комментарий.
```text
```
## Игнорирование форматирования Markdown
Вы можете указать GitHub игнорировать (или экранировать) форматирование Markdown, используя \\ перед символом Markdown.
`Let's rename \*our-new-project\* to \*our-old-project\*.`
Дополнительные сведения об обратных косых чертах см. [в разделе Синтаксис Markdown](https://daringfireball.net/projects/markdown/syntax#backslash) в Daring Fireball.
> \[!NOTE]
> Форматирование Markdown не будет проигнорировано в заголовке проблемы или запроса на вытягивание.
## Отключение отрисовки Markdown
При просмотре файла Markdown можно щелкнуть **код** в верхней части файла, чтобы отключить отрисовку Markdown и просмотреть источник файла.
Отключение обработки файлов Markdown позволяет использовать функции просмотра источника, такие как связывание строк, что невозможно при просмотре обработанных файлов Markdown.
## Дополнительные материалы
* [Спецификация GitHub Flavored Markdown](https://github.github.com/gfm/)
* [О написании и форматировании на GitHub](/ru/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github)
* [Работа с расширенным форматированием](/ru/get-started/writing-on-github/working-with-advanced-formatting)
* [Быстрый старт для написания на GitHub](/ru/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)