Примеры оформления README.md файла для репозиториев Github.

Заголовки.

Для задания заголовка и его уровня используется символ #

# Заголовок 1 уровня.

Заголовок 1 уровня.

## Заголовок 2 уровня.

Заголовок 2 уровня.

### Заголовок 3 уровня.

Заголовок 3 уровня.

#### Заголовок 4 уровня.

Заголовок 4 уровня.

---

Примеры шрифтов.

Для выделения текста с помощью используются символы * или _. Текст, выделенный курсивом:

*Пример*

Пример

_Пример_

Пример

Текст, выделенный полужирным шрифтом:

**Пример**

Пример

__Пример__

Пример

Текст, выделенный курсивным полужирным шрифтом:

***Пример***

Пример

___Пример___

Пример

Надстрочный и подстрочный интервалы в тексте.

Для задания надстрочного и подствочного интервалов в языке Markdown используются HTML теги / и /.
Например:

SSR(p) = |f - g<sub>p</sub>|<sup>2</sup>

Будет выглядеть так:

SSR(p) = |f - g_p|²

Зачеркнутый текст.

Любой текст, заключенное в две тильды, будет зачеркнут. Например,

~~ Зачёркнутый текст ~~

Будет выглядеть так:

Зачёркнутый текст

Абзацы

Вы можете создать новый абзац, оставив пустую строку между строками текста.

Списки

Неупорядоченные списки

Можно создать неупорядоченный список, поставив перед одной или несколькими строками текста знак - или *. Важно закончивать пункт любого списка одним символом пробела.

Например,

- Первый пункт неупорядоченного списка 
* Второй пункт неупорядоченного списка 

Будет выглядеть так:

• Первый пункт неупорядоченного списка

• Второй пункт неупорядоченного списка

Вложенные списки

Можно создать вложенный список, разместив один или несколько элементов списка под другим элементом.

Например,

1. Первый элемнт списка 
   - Первый вложенный элемент списка 
	 - Второй вложенный элемент списка 

Будет выглядеть так:

1. Первый элемнт списка
   • Первый вложенный элемент списка
     • Второй вложенный элемент списка

Упорядоченные списки

Чтобы упорядочить список, ставьте перед каждой строкой номер.

Например,

1. Первый элемент списка	
2. Второй элемент списка	

Будет выглядеть так:

1. Первый элемент списка
2. Второй элемент списка.

Дополнительные элементы - символ обратного слеша ("\")

Символ обратного слеша может использоваться в Markdown перед специальными символами для того, чтобы они воспринимались в их буквальном (а не служебном) значении.

Например,

\Α

Будет выглядеть так:

Α

Но!

Α 

Будет выглядеть так:

Α

Ссылки.

Пример оформления ссылки выглядит следующим образом:

[Ваза](https://ru.wikipedia.org/wiki/%D0%92%D0%B0%D0%B7%D0%B0 "Необязательная подсказка, выводится при наведении курсора мыши")    

В результате на экран выводится следующее:
Ваза

Упрощенный порядок создания ссылок

В Markdown поддерживается упрощённый порядок автоматического создания ссылок для URL-адресов и адресов электронной почты. Для этого необходимо поместить URL-адрес или почтовый адрес в угловые скобки

Например,

<blademoon@yandex.ru>
<https://www.yandex.ru>

Будет выглядеть так:

blademoon@yandex.ru
https://www.yandex.ru

Картинки

Для вставки в текст картинок используется соответсвующий HTML код. В тегах width и height необходимо указать размер картинки, для ее правильного отображения.

<p align="center">
  <img width="400" height="250" src="https://github.com/blademoon/Markdown/blob/main/Picture/cat.jpg">
</p>

В итоге вставляемая картинка будет выглядеть так:

В теге align указывается выравнивание картинки. Картинку можно выровнять по центру (align="center"), а так же по левому (align="left") или правом (align="right") краю.

Упрощенный порядок вставки картинок.

Более простой вариант вставки картинки можно сделать так:

![Image of cat](https://github.com/blademoon/Markdown/blob/main/Picture/cat.jpg)

В итоге вставляемая картинка будет выглядеть так:

НО! Выравнивание картинки по левому краю!

Видео

Есть два варианта вставки видео в Markdown:

Классический синтаксис Markdown

Для того чтобы вставить видео с YouTube с превью картикой нужно использовать следующий синтаксис:

[![Текст к картинке](https://img.youtube.com/vi/YOUTUBE_ID_ВИДЕО/0.jpg)](https://www.youtube.com/watch?v=YOUTUBE_ID_ВИДЕО)

Получить ID от YouTube видео просто. ID это последние символы в ссылке получаемой по нажатию кнопки "Поделиться". Например, полученная с YouTube ссыулка на видео имеет следующий вид https://youtu.be/94HLyui6eVk?si=lEgmVEtMnxgfZjvj, тогда ID 94HLyui6eVk. В итоге видео [![Best job in the world!](https://img.youtube.com/vi/94HLyui6eVk/0.jpg)](https://www.youtube.com/watch?v=94HLyui6eVk) будет выглядеть так:

Использование HTML

Особенностью данного подхода является использование тега video, превью создаётся автоматически. Код вставки следующий:

<video width="320" height="240" controls>
  <source src="./video/a6337faf-38bd-45b3-9733-9ad15a10c217-mp4_720p.mp4" type="video/mp4">
</video>

Вставленное видео выглядит следующим образом:

Блоки кода и подсветка синтаксиса.

Для вставки кода в документ необходимо использовать либо блоки кода (начинаются и заканчиваются сиволами "```"), либо отсупы в 4 символа пробела ( или одину табуляцию). В блоках кода можно использовать подстветку синтаксиса путем указания языка на котором написан этот код.
Пример болка кода:

```c++
#include <iostream>

using namespace std

int main() {
	cout << "This is a C++ code example!"
}
```

Будет выглядеть так:

#include <iostream>
	
using namespace std
	
int main() {
	cout << "This is a C++ code example!"
}

Пример выделения кода с помощью отступов:

#include <iostream>

using namespace std
	
int main() {
	cout << "This is a C++ code example!"

Список задач

Список задач в языке Markdown формируется с помощью следующего синтаксиса:

- [ ] ***Задача №1***
- [X] **Отмеченная задача**
- [ ] *Не выполненная задача*

Будет выглядеть так:

• Задача №1
• Отмеченная задача
• Не выполненная задача

Таблицы

Таблицы Можно создавать таблицы, собирая список слов и разделяя их дефисами - (для первой строки), а затем разделяя каждый столбец вертикальной чертой |: Пример синтаксиса:

Первый столбик заголовка| Второй столбик заголовка
------------ | -------------
Содержимое ячейки 1| Содержимое ячейки 2
Содержимое ячейки 3 | Содержимое ячейки 4

Будет выглядеть так:

Первый столбик заголовка	Второй столбик заголовка
Содержимое ячейки 1	Содержимое ячейки 2
Содержимое ячейки 3	Содержимое ячейки 4

Цитаты.

Для обозначения цитат в языке Markdown используется символ знак «больше» («>»). Уровень цитирования не может превышать 15! Цитирование можно использовать как перед каждой строкой цитаты, так и только перед первой строкой параграфа. Например: >Это пример цитаты, >в которой перед каждой строкой >ставится угловая скобка.

Это пример цитаты, в которой перед каждой строкой ставится угловая скобка.

>Это пример цитаты,
в которой угловая скобка
ставится только перед началом нового параграфа.

>Второй параграф.

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

Второй параграф.

Вложение цитаты в цитату выглядит следующим образом:

> Первый уровень цитирования
>> Второй уровень цитирования
>>> Третий уровень цитирования
>
>Первый уровень цитирования

Первый уровень цитирования

Второй уровень цитирования

Третий уровень цитирования

Первый уровень цитирования

Греческие буквы.

Для вставки в текст греческих символов используются либо обозначения этих символов, либо их код в кодировке UNICODE. Ниже приведена таблица с заглавными и прописными символами греческого алфавита.

Заглавные греческие буквы:

Имя кода	Код	Описание	Отображаемый символ
Α	Α	Большая (заглавная) греческая буква "альфа"	Α
Β	Β	Большая (заглавная) греческая буква "бета"	Β
Γ	Γ	Большая (заглавная) греческая буква "гамма"	Γ
Δ	Δ	Большая (заглавная) греческая буква "дельта"	Δ
Ε	Ε	Большая (заглавная) греческая буква "эпсилон"	Ε
Ζ	Ζ	Большая (заглавная) греческая буква "дзета (зита)"	Ζ
Η	Η	Большая (заглавная) греческая буква "эта (ита)"	Η
Θ	Θ	Большая (заглавная) греческая буква "тэта (фита)"	Θ
Ι	Ι	Большая (заглавная) греческая буква "йота"	Ι
Κ	Κ	Большая (заглавная) греческая буква "каппа"	Κ
Λ	Λ	Большая (заглавная) греческая буква "лямбда (лямда)"	Λ
Μ	Μ	Большая (заглавная) греческая буква "мю (ми)"	Μ
Ν	Ν	Большая (заглавная) греческая буква "ню (ни)	Ν
Ξ	Ξ	Большая (заглавная) греческая буква "кси"	Ξ
Ο	Ο	Большая (заглавная) греческая буква "омикрон"	Ο
Π	Π	Большая (заглавная) греческая буква "пи"	Π
Ρ	Ρ	Большая (заглавная) греческая буква "ро"	Ρ
Σ	Σ	Большая (заглавная) греческая буква "сигма"	Σ
Τ	Τ	Большая (заглавная) греческая буква "тау (тав)"	Τ
Υ	Υ	Большая (заглавная) греческая буква "ипсилон"	Υ
Φ	Φ	Большая (заглавная) греческая буква "фи"	Φ
Χ	Χ	Большая (заглавная) греческая буква "хи"	Χ
Ψ	Ψ	Большая (заглавная) греческая буква "пси"	Ψ
Ω	Ω	Большая (заглавная) греческая буква "омега"	Ω

Маленькие греческие буквы:

Имя кода	Код	Описание	Отображаемый символ
α	α	Маленькая греческая буква "альфа"	α
β	β	Маленькая греческая буква "бета"	β
γ	γ	Маленькая греческая буква "гамма"	γ
δ	δ	Маленькая греческая буква "дельта"	δ
ε	ε	Маленькая греческая буква "эпсилон"	ε
ζ	ζ	Маленькая греческая буква "дзета (зита)"	ζ
η	η	Маленькая греческая буква "эта (ита)"	η
θ	θ	Маленькая греческая буква "тэта (фита)"	θ
ι	ι	Маленькая греческая буква "йота"	ι
κ	κ	Маленькая греческая буква "каппа"	κ
λ	λ	Маленькая греческая буква "лямбда (лямда)"	λ
μ	μ	Маленькая греческая буква "мю (ми)"	μ
ν	ν	Маленькая греческая буква "ню (ни)"	ν
ξ	ξ	Маленькая греческая буква "кси"	ξ
ο	ο	Маленькая греческая буква "омикрон"	ο
π	π	Маленькая греческая буква "пи"	π
ρ	ρ	Маленькая греческая буква "ро"	ρ
σ	σ	Маленькая греческая буква "сигма"	σ
τ	τ	Маленькая греческая буква "тау (тав)"	τ
υ	υ	Маленькая греческая буква "ипсилон"	υ
φ	φ	Маленькая греческая буква "фи"	φ
χ	χ	Маленькая греческая буква "хи"	χ
ψ	ψ	Маленькая греческая буква "пси"	ψ
ω	ω	Маленькая греческая буква "омега"	ω