Разметка README.md в GitHub

Разметка README.md в GitHub

iSergium

Для описания проектов на GitHub используется README.md, который пишется на языке разметки markdown. Что и как поддерживается расписано ниже.

Заголовки

Заголовки задаются значками решётки - сколько их, такого уровня заголовок. Как и в HTML возможен уровень от 1 до 6.

# h1
## h2
### h3
#### h4
##### h5
###### h6

markdown заголовки

Списки

Маркированный

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

- ul
+ ul
  + ul - для вложенных списков нужно поставить 2 пробела
    + ul - третий уровень
      + ul - четвёртый уровень
        + ul - пятый и т.д.
* ul
 * ul
  * ul - если ставить по одному пробелу, то выше второго уровня не подняться

markdown маркированный список

Нумерованный

Нумерованным спискам безразлично с какого числа вы начнёте его - он начнёт с единицы. Точка после числа обязательна. Работа с вложенностями аналогична маркированному списку.

1. ol
  1. ol
    1. ol
      1. ol
2. ol
2. ol - всё равно 3

Если же Вам нужно число с точкой, но не нужен список, то можно сделать так:

1961\. Текст

markdown нумерованный список

Смешанный

Нумерованный и маркированный списки можно смешивать:

* ul
 1. ol
 1. ol

1. ol
 * ul
 * ul

markdown смешанный список

Ссылки

Либо просто вставить ссылку, либо дополнительно задать текст ссылки (пробела между скобками быть не должно):

http://example.com
[example.com](http://example.com)

Можно выводить через "константу", которую можно задать в любом месте, обычно их задают в конце документа.

[example site]
[example site]:http://example.com

markdown ссылки

Цитаты

> Цитата
> > Вложенная цитата

> Продолжение цитаты

markdown цитаты

Начертание шрифта

**bold**
*italic*
***bold italic***
_italic too_

**Можно использовать _курсив_ внутри жирного текста.**

markdown начертание шрифта

Вставки кода

Если нужно выделить слово или фразу внутри строки, то используются одинарные обратные апострофы (`), для выделения в блоки - тройные. Дополнительно можно задавать язык кода внутри блока:

Можно использовать `light-code` внутри строки

```
code block
```

```php
//php code
$foo = new BarClass();
```

markdown вставки кода

Изображения

Описание крайне похоже на описание ссылки, за исключением лишь восклицательного знака в начале.

![alt text](https://avatars2.githubusercontent.com/u/11632545?v=3&s=200)

 markdown изображения