Синтаксис разметки Markdown
Markdown это простой синтаксис разметки для формирования текстовых документов.
О чем вы сейчас узнаете:
- Как разметка Markdown упрощает создание текстовых документов
- Чем Markdown отличается от других форматов
- Как использовать Markdown для форматирования текста
- Какие возможности есть для формирования документации GitHub
Что такое Markdown?
Markdown - это простой способ форматирования текстовых документов. С его помощью можно применить основные стили к форматированию текста. Это выделение слов жирным или курсивом, добавление изображений, создание списков. Перечислены только основные возможности Markdown. В основном, Markdown - простой текст с дополнительными специальными символами, такими как # или *.
Руководство по синтаксису
Это краткое руководство по синтаксису, который вы можете использовать для форматирования своих текстовых файлов .
Заголовки
# Это заголовок первого уровня, эквивалент тегу <h1>
## Это заголовок второго уровня, эквивалент тегу <h2>
###### Заголовок шестого уровня, эквивалент тегу <h6>
Выделения
*Курсив*
_Это тоже курсив_
**Жирный**
__Это тоже жирный__
~~Перечёркнутый~~
_Вы **можете** совмещать стили_
Списки
Маркерованный
* Item 1
* Item 2
* Item 2a
* Item 2b
Нумерованный
1. Item 1
1. Item 2
1. Item 3
1. Item 3a
1. Item 3b
Цифра впереди значение не имеет, важно её наличие. Отсчет номеров в списке начинается с той цифры, которая указана у первого элемента.
Изображения
Формат: 
Ссылки
[Редактор Write4](https://write4.ru)
Формат: [Текст ссылки](url)
Цитаты
Фёдор Тютчев сказал:
> Чему бы жизнь нас ни учила,
> Но сердце верит в чудеса…
Встроенный код
Я думаю, что нужно использовать элемент
`<addr>` для отображения адреса в этом поле.
Код и подсветка синтаксиса
Код можно оформлять с указанием языка программирования, для включения подсветки синтаксиса, но можно и без него
'''javascript
>function fancyAlert(arg) {
> if(arg) {
$.facebox({div:'#foo'})
}
}
'''
Вместо апострофа используйте обратный апостроф
Отступы можно делать с помощью пробела:
function fancyAlert(arg) {
if(arg) {
$.facebox({div:'#foo'})
}
}
Пример подсветки кода для языка Python:
def foo():
if not bar:
return True
Список задач
- [x] @mentions, #refs, [links](), **formatting**, and <del>tags</del> supported
- [x] list syntax required (any unordered or ordered list supported)
- [x] this is a complete item
- [ ] this is an incomplete item
Актуально для создания документации при использовании её, например, на GitHub
При просмотре в данном редакторе не имеет специфического оформления
Если вставить список задач в первый комментарий к вопросу на GitHub, то будет виден индикатор выполнения. Также возможно использование для Pull запросов.
Таблицы
You can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe |:
Заголовок 1 | Заголовок 2
----------- | -----------
Содержание ячейки 1.1 | Содержание ячейки 1.2
Содержание ячейки 2.1 | Содержание ячейки 2.2
Результат:
| Заголовок 1 | Заголовок 2 |
|---|---|
| Содержание ячейки 1.1 | Содержание ячейки 1.2 |
| Содержание ячейки 2.1 | Содержание ячейки 2.2 |
SHA ссылки (Только для документации GitHub)
Любые ссылки на коммиты являющиеся хэшем SHA-1 будут автоматически перенапрявлять на соответствующий коммит данного епозитория GitHub.
16c999e8c71134401a78d4d46435517b2271d6ac
mojombo@16c999e8c71134401a78d4d46435517b2271d6ac
mojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac
Ссылки по репозиторию (Только для документации GitHub)
Любые числа, являющиеся ссылкой на вопрос или pull request будут автоматически конвертированы
#1
mojombo#1
mojombo/github-flavored-markdown#1