Markdown-Cheatsheet/README.md

381 lines
18 KiB
Markdown
Raw Normal View History

2014-05-29 19:31:04 +10:00
Шпаргалка по Markdown
2014-06-07 03:56:14 +10:00
---------------------
2014-05-29 19:31:04 +10:00
(перевод, [оригинал](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet))
Поиграть с разметкой Markdown можно на [демо-странице](http://www.markdown-here.com/livedemo.html).
##### Содержание
[Заголовки](#headers)
2014-05-29 20:43:38 +10:00
[Выделение](#emphasis)
2014-05-29 19:31:04 +10:00
[Списки](#lists)
[Ссылки](#links)
[Изображения](#images)
[Подсветка кода и синтаксиса](#code)
[Таблицы](#tables)
[Цитаты](#blockquotes)
[Встроенный HTML](#html)
[Горизонтальная линия](#hr)
2014-05-31 08:01:03 +10:00
[Новая строка](#lines)
2014-05-29 19:31:04 +10:00
[Видео Youtube](#videos)
2014-05-29 19:24:42 +10:00
2017-03-23 02:18:24 +09:00
<a name="headers"><h2>Заголовки</h2></a>
2014-05-29 19:24:42 +10:00
```no-highlight
# H1
## H2
### H3
#### H4
##### H5
###### H6
2014-05-29 20:43:38 +10:00
Кроме того, H1 и H2 можно обозначить подчеркиванием:
2014-05-29 19:24:42 +10:00
Alt-H1
======
Alt-H2
------
```
# H1
## H2
### H3
#### H4
##### H5
###### H6
2014-05-29 20:43:38 +10:00
Кроме того, заголовки H1 и H2 можно обозначить подчеркиванием:
2014-05-29 19:24:42 +10:00
Alt-H1
======
Alt-H2
------
2017-03-23 02:18:24 +09:00
<a name="emphasis"><h2>Выделение</h2></a>
2014-05-29 19:24:42 +10:00
```no-highlight
2014-05-29 20:43:38 +10:00
Курсив обозначается *звездочками* или _подчеркиванием_.
2014-05-29 19:24:42 +10:00
2014-05-29 20:43:38 +10:00
Полужирный шрифт - двойными **звездочками** или __подчеркиванием__.
2014-05-29 19:24:42 +10:00
2014-05-29 20:43:38 +10:00
Комбинированное выделение **звездочками и _подчеркиванием_**.
2014-05-29 19:24:42 +10:00
2014-05-29 20:43:38 +10:00
Для зачеркнутого текста используются две тильды . ~~Уберите это.~~
2014-05-29 19:24:42 +10:00
```
2014-05-29 20:43:38 +10:00
Курсив обозначается *звездочками* или _подчеркиванием_.
2014-05-29 19:24:42 +10:00
2014-05-29 20:43:38 +10:00
Полужирный шрифт - двойными **звездочками** или __подчеркиванием__.
2014-05-29 19:24:42 +10:00
2014-05-29 20:43:38 +10:00
Комбинированное выделение **звездочками и _подчеркиванием_**.
2014-05-29 19:24:42 +10:00
2014-05-29 20:43:38 +10:00
Для зачеркнутого текста используются две тильды . ~~Уберите это.~~
2014-05-29 19:24:42 +10:00
2017-03-23 02:18:24 +09:00
<a name="lists"><h2>Списки</h2></a>
2014-05-29 19:24:42 +10:00
2014-05-29 20:43:38 +10:00
(В данном примере предшествующие и завершающие пробелы обозначены точками: ⋅)
2014-05-29 19:24:42 +10:00
```no-highlight
2014-05-29 20:43:38 +10:00
1. Первый пункт нумерованного списка
2. Второй пункт
⋅⋅*Ненумерованный вложенный список.
1. Сами числа не имеют значения, лишь бы это были цифры
⋅⋅1. Нумерованный вложенный список
4. И еще один пункт.
2014-05-29 19:24:42 +10:00
2014-05-29 21:50:10 +10:00
⋅⋅⋅Внутри пунктов списка можно вставить абзацы с таким же отступом. Обратите внимание на пустую строку выше и на пробелы в начале (нужен по меньшей мере один, но здесь мы добавили три, чтобы также выровнять необработанный Markdown).
2014-05-29 19:24:42 +10:00
2014-05-29 21:50:10 +10:00
⋅⋅⋅Чтобы вставить разрыв строки, но не начинать новый параграф, нужно добавить два пробела перед новой строкой.⋅⋅
2016-05-05 06:01:38 +09:00
⋅⋅⋅Этот текст начинается с новой строки, но находится в том же абзаце.⋅⋅
2014-05-29 21:50:10 +10:00
⋅⋅⋅(В некоторых обработчиках, например на Github, пробелы в начале новой строки не нужны.)
2014-05-29 19:24:42 +10:00
2014-05-29 21:50:10 +10:00
* Ненумерованный список можно размечать звездочками
- Или минусами
+ Или плюсами
2014-05-29 19:24:42 +10:00
```
2014-05-29 21:50:10 +10:00
1. Первый пункт нумерованного списка
2. Второй пункт
* Ненумерованный вложенный список.
1. Сами числа не имеют значения, лишь бы это были цифры
1. Нумерованный вложенный список
4. И еще один пункт.
2014-05-29 19:24:42 +10:00
2014-05-29 21:04:38 +10:00
Внутри пунктов списка можно вставить абзацы с таким же отступом. Обратите внимание на пустую строку выше и на пробелы в начале (нужен по меньшей мере один, но здесь мы добавили три, чтобы также выровнять необработанный Markdown).
2014-05-29 19:24:42 +10:00
2014-05-29 21:04:38 +10:00
Чтобы вставить разрыв строки, но не начинать новый параграф, нужно добавить два пробела перед новой строкой.
Эта текст начинается с новой строки, но находится в том же абзаце.
(В некоторых обработчиках, например на Github, пробелы в начале новой строки не нужны.)
2014-05-29 19:24:42 +10:00
2014-05-29 21:04:38 +10:00
* Ненумерованный список можно размечать звездочками
- Или минусами
+ Или плюсами
2014-05-29 19:24:42 +10:00
2017-03-23 02:18:24 +09:00
<a name="links"><h2>Ссылки</h2></a>
2014-05-29 19:24:42 +10:00
2018-04-17 15:27:16 +09:00
Ссылки можно оформить разными способами.
2014-05-29 19:24:42 +10:00
```no-highlight
2014-05-29 21:04:38 +10:00
[Обычная ссылка в строке](https://www.google.com)
2014-05-29 19:24:42 +10:00
2014-05-29 21:04:38 +10:00
[Обычная ссылка с title](https://www.google.com "Сайт Google")
2014-05-29 19:24:42 +10:00
2014-05-29 21:04:38 +10:00
[Ссылка со сноской][Произвольный регистронезависимый текст]
2014-05-29 19:24:42 +10:00
2014-05-29 21:04:38 +10:00
[Относительная ссылка на документ](../blob/master/LICENSE)
2014-05-29 19:24:42 +10:00
2014-05-29 21:04:38 +10:00
[Для ссылок со сноской можно использовать цифры][1]
2014-05-29 19:24:42 +10:00
2014-05-29 21:04:38 +10:00
Или можно просто вставить ссылку в квадратные скобки [текст ссылки]
2014-05-29 19:24:42 +10:00
2018-04-17 15:28:01 +09:00
Произвольный текст, после которого можно указать сами ссылки.
2014-05-29 19:24:42 +10:00
2014-05-29 21:04:38 +10:00
[произвольный регистронезависимый текст]: https://www.mozilla.org
2014-05-29 19:24:42 +10:00
[1]: http://slashdot.org
2014-05-29 21:04:38 +10:00
[текст ссылки]: http://www.reddit.com
2014-05-29 19:24:42 +10:00
```
2014-05-29 21:04:38 +10:00
[Обычная ссылка в строке](https://www.google.com)
2014-05-29 19:24:42 +10:00
2014-05-29 21:04:38 +10:00
[Обычная ссылка с title](https://www.google.com "Сайт Google")
2014-05-29 19:24:42 +10:00
2014-05-29 21:11:26 +10:00
[Ссылка со сноской][Произвольный регистронезависимый текст] *
2014-05-29 19:24:42 +10:00
2014-05-29 21:04:38 +10:00
[Относительная ссылка на документ](../blob/master/LICENSE)
2014-05-29 19:24:42 +10:00
2014-05-29 21:04:38 +10:00
[Для ссылок со сноской можно использовать цифры][1]
2014-05-29 19:24:42 +10:00
2014-05-29 21:04:38 +10:00
Или можно просто вставить ссылку в квадратные скобки [текст ссылки]
2014-05-29 19:24:42 +10:00
2018-04-17 15:27:16 +09:00
Произвольный текст, после которого можно привести ссылки.
2014-05-29 19:24:42 +10:00
2014-05-29 21:11:26 +10:00
[Произвольный регистронезависимый текст]: https://www.mozilla.org
2014-05-29 19:24:42 +10:00
[1]: http://slashdot.org
2014-05-29 21:04:38 +10:00
[текст ссылки]: http://www.reddit.com
2014-05-29 19:24:42 +10:00
2014-05-29 21:11:26 +10:00
(*) Для символов не входящих в ASCII, например кириллицы, текст сноски все-таки регистрозависим (прим. перев.)
2017-03-23 02:18:24 +09:00
<a name="images"><h2>Изображения</h2></a>
2014-05-29 19:24:42 +10:00
```no-highlight
2014-05-29 21:50:10 +10:00
Вот наш логотип (наведите указатель, чтобы увидеть текст заголовка):
2014-05-29 19:24:42 +10:00
2017-05-01 16:18:56 +09:00
Внутри строки:
2014-05-29 21:50:10 +10:00
![alt-текст](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Текст заголовка логотипа 1")
2014-05-29 19:24:42 +10:00
2017-05-01 16:18:56 +09:00
В сноске:
2014-05-29 21:50:10 +10:00
![alt-текст][logo]
2014-05-29 19:24:42 +10:00
2014-05-29 21:50:10 +10:00
[logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Текст заголовка логотипа 2"
2014-05-29 19:24:42 +10:00
```
2014-05-29 21:50:10 +10:00
Вот наш логотип (наведите указатель, чтобы увидеть текст заголовка):
2014-05-29 19:24:42 +10:00
2017-05-01 16:18:56 +09:00
Внутри строки:
2014-05-29 21:50:10 +10:00
![alt-текст](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Текст заголовка логотипа 1")
2014-05-29 19:24:42 +10:00
2017-05-01 16:18:56 +09:00
В сноске:
2014-05-29 21:50:10 +10:00
![alt-текст][logo]
2014-05-29 19:24:42 +10:00
2014-05-29 21:50:10 +10:00
[logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Текст заголовка логотипа 2"
2014-05-29 19:24:42 +10:00
2017-03-23 02:18:24 +09:00
<a name="code"><h2>Код и подсветка синтаксиса</h2></a>
2014-05-29 19:24:42 +10:00
2014-05-29 21:50:10 +10:00
Блоки кода являются частью функций Markdown, но не подсветка синтаксиса. Однако многие обработчики, например Github или *Markdown Here*, поддерживают подсветку синтаксиса. Список поддерживаемых языков и способ их указания может различаться. *Markdown Here* поддерживает десятки языков (и не-языков, например синтаксис diff и заголовки HTTP); полный список и способ указания языков см. на странице [highlight.js demo-странице](http://softwaremaniacs.org/media/soft/highlight/test.html).
2014-05-29 19:24:42 +10:00
```no-highlight
2014-05-29 21:50:10 +10:00
`Код` в строке обрамляется `обратными апострофами`.
2014-05-29 19:24:42 +10:00
```
2014-05-29 21:50:10 +10:00
`Код` в строке обрамляется `обратными апострофами`.
2014-05-29 19:24:42 +10:00
2014-05-29 21:50:10 +10:00
Блоки кода выделяются либо тремя обратными апострофами <code>```</code> либо четырьмя пробелами в каждой строке. Рекомендуется использовать три апострофа -- они проще и только они поддерживают подсветку синтаксиса.
2014-05-29 19:24:42 +10:00
<pre lang="no-highlight"><code>```javascript
2014-05-29 21:50:10 +10:00
var s = "Подсветка JavaScript";
2014-05-29 19:24:42 +10:00
alert(s);
```
```python
2014-05-29 21:50:10 +10:00
s = "Подсветка Python"
2014-05-29 19:24:42 +10:00
print s
```
```
2014-05-29 21:50:10 +10:00
Язык не указан, синтаксис не подсвечен.
2016-05-05 06:01:38 +09:00
Но мы вставим в него &lt;b&gt;тег&lt;/b&gt;.
2014-05-29 19:24:42 +10:00
```
</code></pre>
```javascript
2014-05-29 21:50:10 +10:00
var s = "Подсветка JavaScript";
2014-05-29 19:24:42 +10:00
alert(s);
```
2014-05-29 21:50:10 +10:00
2014-05-29 19:24:42 +10:00
```python
2014-05-29 21:50:10 +10:00
s = "Подсветка Python"
2014-05-29 19:24:42 +10:00
print s
```
```
2014-05-29 21:50:10 +10:00
Язык не указан, синтаксис не подсвечен (некоторые обработчики все же подсвечивают).
2016-05-05 06:01:38 +09:00
Но мы вставим в него <b>тег</b>.
2014-05-29 19:24:42 +10:00
```
2017-03-23 02:18:24 +09:00
<a name="tables"><h2>Таблицы</h2></a>
2014-05-29 19:24:42 +10:00
2014-05-29 21:50:10 +10:00
Таблицы не являются частью Markdown, но многие обработчики, например *Markdown Here* и Github, поддерживают их. Они позволяют легко добавить таблицы в электронное письмо -- в других случаях для этого нужно копировать их из другого приложения.
2014-05-29 19:24:42 +10:00
```no-highlight
2014-05-29 21:50:10 +10:00
Вертикальные линии обозначают столбцы.
2014-05-29 19:24:42 +10:00
2014-05-29 21:50:10 +10:00
| Таблицы | Это | Круто |
| ------------- |:------------------:| -----:|
| столбец 3 | выровнен вправо | $1600 |
| столбец 2 | выровнен по центру | $12 |
| зебра-строки | прикольные | $1 |
2014-05-29 19:24:42 +10:00
2014-05-29 21:50:10 +10:00
Внешние вертикальные линии (|) не обязательны, и они нужны только чтобы сам код Markdown выглядел красиво. Тот же код можно записать так:
2014-05-29 19:24:42 +10:00
2014-05-29 21:50:10 +10:00
Markdown | не такой | красивый
2014-05-29 19:24:42 +10:00
--- | --- | ---
2014-05-29 21:50:10 +10:00
*Но выводится* | `так же` | **клево**
2014-05-29 19:24:42 +10:00
1 | 2 | 3
```
2014-05-29 21:50:10 +10:00
Вертикальные линии обозначают столбцы.
2014-05-29 19:24:42 +10:00
2014-05-29 21:50:10 +10:00
| Таблицы | Это | Круто |
| ------------- |:------------------:| -----:|
| столбец 3 | выровнен вправо | $1600 |
| столбец 2 | выровнен по центру | $12 |
2014-05-31 08:00:21 +10:00
| зебра-строки | прикольные | $1 |
2014-05-29 19:24:42 +10:00
2014-05-29 21:50:10 +10:00
Внешние вертикальные линии (|) не обязательны, и они нужны только чтобы сам код Markdown выглядел красиво. Тот же код можно записать так:
2014-05-29 19:24:42 +10:00
2014-05-29 21:50:10 +10:00
Markdown | не такой | красивый
2014-05-29 19:24:42 +10:00
--- | --- | ---
2014-05-29 21:50:10 +10:00
*Но выводится* | `так же` | **клево**
2014-05-29 19:24:42 +10:00
1 | 2 | 3
2017-03-23 02:18:24 +09:00
<a name="blockquotes"><h2>Цитаты</h2></a>
2014-05-29 19:24:42 +10:00
```no-highlight
2014-05-31 08:00:21 +10:00
> С помощью цитат очень удобно в письме обозначать исходный текст.
> Эта строка - часть той же цитаты.
2014-05-29 19:24:42 +10:00
2014-05-31 08:00:21 +10:00
Разрыв цитаты.
2014-05-29 19:24:42 +10:00
2014-05-31 08:00:21 +10:00
> Это очень длинная строка, но она будет правильно процитирована даже при размещении на нескольких строках. Продолжаем писать, чтобы эта строка не вмещалась на одной строке в любом окне. Кстати, в цитаты можно *вставлять* даже **Markdown**.
2014-05-29 19:24:42 +10:00
```
2014-05-31 08:00:21 +10:00
> С помощью цитат очень удобно в письме обозначать исходный текст.
> Эта строка - часть той же цитаты.
2014-05-29 19:24:42 +10:00
2014-05-31 08:00:21 +10:00
Разрыв цитаты.
2014-05-29 19:24:42 +10:00
2014-05-31 08:00:21 +10:00
> Это очень длинная строка, но она будет правильно процитирована даже при размещении на нескольких строках. Продолжаем писать, чтобы эта строка не вмещалась на одной строке в любом окне. Кстати, в цитаты можно также *размечать* с помощью **Markdown**.
2014-05-29 19:24:42 +10:00
2017-03-23 02:20:23 +09:00
<a name="html"><h2>Встроенный HTML</h2></a>
2014-05-29 19:24:42 +10:00
2014-05-31 08:00:21 +10:00
Часто Markdown понимает чистый HTML.
2014-05-29 19:24:42 +10:00
```no-highlight
<dl>
2014-05-31 08:00:21 +10:00
<dt>Список определений</dt>
<dd>Это то, что люди иногда используют.</dd>
2014-05-29 19:24:42 +10:00
2014-05-31 08:00:21 +10:00
<dt>Markdown внутри HTML</dt>
<dd>Работает *не очень** хорошо. Используйте HTML-<em>теги</em>.</dd>
2014-05-29 19:24:42 +10:00
</dl>
```
<dl>
2014-05-31 08:00:21 +10:00
<dt>Список определений</dt>
<dd>Это то, что люди иногда используют.</dd>
2014-05-29 19:24:42 +10:00
2014-05-31 08:00:21 +10:00
<dt>Markdown внутри HTML</dt>
<dd>Работает *не очень** хорошо. Используйте HTML-<em>теги</em>.</dd>
2014-05-29 19:24:42 +10:00
</dl>
2017-03-23 02:18:24 +09:00
<a name="hr"><h2>Горизонтальные линии</h2></a>
2014-05-29 19:24:42 +10:00
```
2014-05-31 08:00:21 +10:00
Три и более...
2014-05-29 19:24:42 +10:00
---
2014-05-31 08:00:21 +10:00
Дефисы
2014-05-29 19:24:42 +10:00
***
2014-05-31 08:00:21 +10:00
Звездочки
2014-05-29 19:24:42 +10:00
___
2014-05-31 08:00:21 +10:00
Подчеркивания
2014-05-29 19:24:42 +10:00
```
2014-05-31 08:00:21 +10:00
Три и более...
2014-05-29 19:24:42 +10:00
---
2014-05-31 08:00:21 +10:00
Дефисы
2014-05-29 19:24:42 +10:00
***
2014-05-31 08:00:21 +10:00
Звездочки
2014-05-29 19:24:42 +10:00
___
2014-05-31 08:00:21 +10:00
Подчеркивания
2014-05-29 19:24:42 +10:00
2017-03-23 02:18:24 +09:00
<a name="lines"><h2>Новая строка</h2></a>
2014-05-29 19:24:42 +10:00
2017-03-23 02:22:14 +09:00
Для понимания работы разрыва строка автор главным образом рекомендует экспериментировать и пробовать -- нажмите &lt;Enter&gt; один раз (т.е. перейдите на новую строку), потом нажмите дважды (т.е. вставьте две новые строки) и посмотрите что приозошло. Вы сразу поймете что вам нужно. В расширении [Markdown Here](https://github.com/adam-p/markdown-here) для браузеров есть удобная функция "Markdown Toggle", которая поможет в этом.
2017-03-11 10:06:51 +09:00
*Примечание переводчика:*
2017-03-11 10:08:37 +09:00
*Для переноса на новую строку в конце предыдущей строки необходимо добавить* **два пробела**. *Без этого большинство парсеров Markdown не выполняют переход на новую строку.*
2014-05-29 19:24:42 +10:00
2014-05-31 08:00:21 +10:00
Попробуйте ввести следующее:
2014-05-29 19:24:42 +10:00
```
2014-05-31 08:00:21 +10:00
Это начальная строка
2014-05-29 19:24:42 +10:00
2014-05-31 08:00:21 +10:00
Эта строка отделена от предыдущей двумя новыми строками и станет *отдельным абзацем*.
2014-05-29 19:24:42 +10:00
2017-03-12 06:12:37 +09:00
Это тоже отдельный абзац, но...⋅⋅
2014-05-31 08:00:21 +10:00
Эта строка отделена одной новой строкой, поэтому она находится в *том же абзаце*.
2014-05-29 19:24:42 +10:00
```
2014-05-31 08:00:21 +10:00
Это начальная строка
2014-05-29 19:24:42 +10:00
2014-05-31 08:00:21 +10:00
Эта строка отделена от предыдущей двумя новыми строками и станет *отдельным абзацем*.
2014-05-29 19:24:42 +10:00
2017-03-11 10:06:51 +09:00
Это тоже отдельный абзац, но...`[здесь два пробела]`
Эта строка отделена одной новой строкой, поэтому она находится в *том же абзаце*.
2014-05-29 19:24:42 +10:00
2014-05-31 08:04:27 +10:00
(Примечание: В [Markdown Here](https://github.com/adam-p/markdown-here) разрывы строк ведут себя так же, как в [GFM](https://help.github.com/articles/github-flavored-markdown), поэтому не нужно вставлять по две новые строки.)
2014-05-29 19:24:42 +10:00
2017-03-23 02:18:24 +09:00
<a name="videos"><h2>Видео Youtube</h2></a>
2014-05-29 19:24:42 +10:00
2014-09-28 19:54:04 +10:00
Ролики нельзя вставить напрямую, но можно вставить изображение со ссылкой на видео, например:
2014-05-29 19:24:42 +10:00
```no-highlight
2014-05-31 08:00:21 +10:00
<a href="http://www.youtube.com/watch?feature=player_embedded&v=ID_ВИДЕОРОЛИКА_НА_YOUTUBE" target="_blank"><img src="http://img.youtube.com/vi/ID_ВИДЕОРОЛИКА_НА_YOUTUBE/0.jpg"
alt="ALT-ТЕКСТ ИЗОБРАЖЕНИЯ" width="240" height="180" border="10" /></a>
2014-05-29 19:24:42 +10:00
```
2014-05-31 08:00:21 +10:00
На чистом Markdown, но без размеров изображения и рамки:
2014-05-29 19:24:42 +10:00
```no-highlight
2014-05-31 08:00:21 +10:00
[![ALT-ТЕКСТ ИЗОБРАЖЕНИЯ](http://img.youtube.com/vi/ID_ВИДЕОРОЛИКА_НА_YOUTUBE/0.jpg)](http://www.youtube.com/watch?v=ID_ВИДЕОРОЛИКА_НА_YOUTUBE)
2014-05-29 19:24:42 +10:00
```