Для визуального оформления текстового файла документации README.md используется уникальный упрощенный синтаксис (так называемый язык Markdown).

[Заголовки]

# Это пример заголовка h1
## Это пример заголовка h2
###### Это пример заголовка h6

Вот как это может выглядеть:

Это пример заголовка h1
Это пример заголовка h2
Это пример заголовка h6

Аналогично могут быть оформлены заголовки h3, h4, h5 и т. п.

[Акцент]

*Это наклонный текст (italic)*
_Это тоже наклонный текст_

**Это пример жирного текста (bold)**
__Это тоже жирный текст__

Вот так это будет выглядеть:

Это наклонный текст (italic)
Это тоже наклонный текст

Это пример жирного текста (bold)
Это тоже жирный текст

_Вы можете комбинировать эти стили, **вкладывая** их друг в друга_:

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

[Списки]

Пример неупорядоченного списка:

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

[Вставка картинки]


[Вставка ссылки]

Вы можете использовать [Markdown Live Preview](https://markdownlivepreview.com/).

Это будет выглядеть так:

Вы можете использовать Markdown Live Preview .

[Блоки цитирования]

> Markdown это облегченный язык разметки текста, созданный в 2004 году John Gruber и Aaron Swartz.
>
>> Markdown часто используется как формат для файлов readme, для написания сообщений в дискуссионных онлайн-форумах, и для создания богатого оформления текста с помощью простого текстового редактора наподобие notepad или vim.

[Таблицы]

| Левые столбцы | Правые столбцы |
| ------------- |:--------------:|
| left foo      | right foo      |
| left bar      | right bar      |
| left baz      | right baz      |

[Блоки кода]

```
let message = 'Hello world';
alert(message);
```

let message = 'Hello world';
alert(message);

GitHub распознает синтаксис многих языков, язык можно указать следующим образом, например для кода C++:

```CPP
int main (void)
{
   printf("hello world);
}
```

int main (void)
{
   printf("hello world);
}

.. или для INI-файла:

```CPP
[S1]
# Комментарий
Key1=Hello World

[S2]
# Еще комментарий
Key2=Worldly Hello
```

[S1]
# Комментарий
Key1=Hello World

[S2]
# Еще комментарий
Key2=Worldly Hello

[Полезные советы]

1. VScode имеет удобную функцию рендеринга и предпросмотра файла readme.md. Ctrl+Shift+v откроет отрендеренный предпросмотр. Ctrl+k v откроет дополнительное окошко справа для предпросмотра.

2. Чтобы строки не склеивались в одну строку, в конце строки надо добавлять 2 пробела.

3. Как конвертировать Markdown в HTML (онлайн-конвертеры):

Markdown to HTML
Dillinger
StackEdit

4. Локальные инструменты:

Pandoc (мощный конвертер документов)

pandoc input.md -o output.html

Расширения для редакторов (VS Code, Atom, Sublime Text)

Библиотеки для Python, JavaScript и др.

Встроенная поддержка на многих платформах (GitHub, GitLab и др. автоматически отображают Markdown как HTML).

5. Основные правила преобразования:

[Ссылки]

1. GitHub Basic writing and formatting syntax.
2. Quickstart for writing on GitHub.
3. Editor.md.
4. Markdown Live Preview.