summaryrefslogtreecommitdiffhomepage
path: root/ru-ru/markdown-ru.html.markdown
blob: 3b1293f992de1db4bc683d3bb9d9b7037440d3a7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
---
language: markdown
contributors:
    - ["Dan Turkel", "http://danturkel.com/"]
    - ["Jacob Ward", "http://github.com/JacobCWard/"]
translators:
    - ["Pirogov Alexey", "http://twitter.com/alex_pir"]
    - ["Andre Polykanine", "https://github.com/Oire"]
filename: markdown-ru.md
lang: ru-ru
---

Язык разметки Markdown создан Джоном Грубером (англ. John Gruber)
в 2004 году.
Авторы задавались целью создать максимально удобочитаемый
и удобный в публикации облегчённый язык разметки,
пригодный для последующего преобразования в HTML
(а также и в другие форматы).

Также реализации Markdown варьируют в зависимости от парсера.
В этом руководстве будет указано, какие функции универсальны для языка,
а какие зависят от конкретного парсера.

## HTML-элементы

Markdown является надмножеством HTML, поэтому любой HTML-файл является
корректным документом Markdown.

```md
<!-- Это позволяет использовать напрямую
любые элементы HTML-разметки, такие, например, как этот комментарий.
  Встроенные в документ HTML-элементы не затрагиваются парсером Markdown
и попадают в итоговый HTML без изменений. Однако следует понимать,
что эта же особенность не позволяет использовать разметку Markdown внутри
HTML-элементов -->
```

## Заголовки

HTML-элементы от `<h1>` до `<h6>` размечаются очень просто:
текст, который должен стать заголовком, предваряется
соответствующим количеством символов "#":

```md
# Это заголовок h1
## Это заголовок h2
### Это заголовок h3
#### Это заголовок h4
##### Это заголовок h5
###### Это заголовок h6
```

Markdown позволяет размечать заголовки `<h1>` и `<h2>` ещё одним способом:

```md
Это заголовок h1
================

А это заголовок h2
------------------
```

## Простейшая стилизация текста

Текст легко сделать полужирным и/или курсивным:

```md
*Этот текст будет выведен курсивом.*
_Так же, как этот._

**А этот текст будет полужирным.**
__И этот тоже.__

***Полужирный курсив.***
**_И тут!_**
*__И даже здесь!__*
```

В GitHub Flavored Markdown, стандарте, который используется в GitHub,
текст также можно сделать зачёркнутым:

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

## Абзацы

Абзацами являются любые строки, следующие друг за другом.
Разделяются же абзацы одной или несколькими пустыми строками:

```md
Это абзац. Я печатаю в абзаце, разве это не прикольно?

А тут уже абзац №2.
Эта строка всё ещё относится к абзацу №2!


О, а вот это уже абзац №3!
```

Для вставки принудительных переносов можно завершить абзац двумя
дополнительными пробелами:

```md
Эта строка завершается двумя пробелами (выделите, чтобы увидеть!).

Над этой строкой есть <br />!
```

Цитаты размечаются с помощью символа «>»:

```md
> Это цитата. В цитатах можно
> принудительно переносить строки, вставляя «>» в начало каждой следующей строки. А можно просто оставлять их достаточно длинными, и такие длинные строки будут перенесены автоматически.
> Разницы между этими двумя подходами к переносу строк нет, коль скоро
> каждая строка начинается с символа «>»

> А ещё цитаты могут быть многоуровневыми:
>> как здесь
>>> и здесь :)
> Неплохо?
```

## Списки

Маркированные списки размечаются вставкой в начало каждого элемента
одного из символов «*», «+» или «-»:
(символ должен быть одним и тем же для всех элементов)

```md
* Список,
* Размеченный
* Звёздочками

либо

+ Список,
+ Размеченный
+ Плюсами

либо

- Список,
- Размеченный
- Дефисами
```

В нумерованных списках каждая строка начинается
с числа и точки вслед за ним:

```md
1. Первый элемент
2. Второй элемент
3. Третий элемент
```

Заметьте, нумеровать элементы корректно необязательно. Достаточно указать
любое число в начале каждого элемента, и парсер пронумерует элементы сам!
Правда, злоупотреблять этим не стоит :)

```md
1. Первый элемент
1. Второй элемент
1. Третий элемент
```

(Этот список будет отображён так же, как и предыдущий!)

Списки могут быть вложенными:

```md
1. Введение
2. Начало работы
3. Примеры использования
    * Простые
    * Сложные
4. Заключение
```

Можно даже делать списки задач. Блок ниже создаёт HTML-флажки.

```md
Для отметки флажка используйте «x»
- [ ] Первая задача
- [ ] Вторая задача
Этот флажок ниже будет отмечен
- [x] Задача была завершена
```

## Блоки кода

Фрагменты исходного кода (обычно отмечаемые тегом `<code>`) выделяются просто:
каждая строка блока должна иметь отступ в четыре пробела либо в один символ табуляции.

```md
    Это код,
    причём многострочный
```

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

```md
    my_array.each do |item|
      puts item
    end
```

Иногда бывает нужно вставить фрагмент кода прямо в строку текста,
не выделяя код в блок. Для этого фрагменты кода нужно обрамлять
символами «`»:

```md
Ваня даже не знал, что делает функция `go_to()`!
```

В GitHub Flavored Markdown для блоков кода можно использовать
специальный синтаксис:

````md
```ruby
def foobar
  puts "Привет, мир!"
end
```
````

Во фрагменте, приведённом выше, отступ не требуется.
Кроме того, GitHub подсветит синтаксис языка, указанного после <code>```</code>

## Горизонтальный разделитель

Разделители (`<hr>`) добавляются вставкой строки из трёх и более
(одинаковых) символов «*» или «-», с пробелами или без них:

```md
***
---
- - -
****************
```

## Ссылки

Одной из сильных сторон Markdown можно смело считать то,
как просто размечаются гиперссылки. Для создания ссылки укажите
текст ссылки, заключив его в квадратные скобки,
и сразу после — URL-адрес, заключенный в круглые

```md
[Ссылка!](http://test.com/)
```

Также для ссылки можно указать всплывающую подсказку (`title`), используя
кавычки внутри круглых скобок:

```md
[Ссылка!](http://test.com/ "Ссылка на Test.com")
```

Относительные пути тоже возможны:

```md
[Перейти к музыке](/music/).
```

Markdown также позволяет размечать ссылку в виде сноски:

```md
[Щёлкните эту ссылку][link1] для подробной информации!
[Также посмотрите эту ссылку,][foobar] если хотите.

[link1]: http://test.com/ "Круто!"
[foobar]: http://foobar.biz/ "Нормально!"
```

`Title` также может быть в одинарных кавычках или круглых скобках, а также
отсутствовать вовсе. Ссылки на сноски могут быть в любом месте документа,
а идентификаторы могут быть какими угодно, лишь бы они были уникальными.

Существует также неявное именование, когда ссылка является идентификатором.

```md
[Это][] ссылка.

[это]: http://thisisalink.com/
```

Правда, эта возможность не очень распространена.

## Изображения

Разметка изображений очень похожа на разметку ссылок.
Нужно всего лишь добавить перед ссылкой восклицательный знак!

```md
![Альтернативный текст для изображения](http://imgur.com/myimage.jpg "Подсказка")
```

Изображения тоже могут быть оформлены как сноски.

```md
![Это альтернативный текст.][myimage]

[myimage]: relative/urls/cool/image.jpg "Если нужна подсказка, её можно добавить"
```

## Разное

### Автоссылки

```md
Ссылка вида <http://testwebsite.com/> эквивалентна
[http://testwebsite.com/](http://testwebsite.com/)
```

### Автоссылки для адресов электронной почты

```md
<foo@bar.com>
```

### Экранирование символов

```md
Я хочу напечатать *текст, заключённый в звёздочки*, но я не хочу,
чтобы он был курсивным. Тогда я делаю так:
\*Текст, заключённый в звёздочки\*
```

### Клавиши на клавиатуре

В GitHub Flavored Markdown для представления клавиш на клавиатуре
вы можете использовать тег `<kbd>`.

```md
Ваш компьютер завис? Попробуйте нажать
<kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd>
```

### Таблицы

Таблицы официально поддерживаются только в GitHub Flavored Markdown,
да и синтаксис имеют не слишком удобный.
Но если очень нужно, размечайте таблицы так:

```md
| Столбец 1    | Столбец 2    | Столбец 3    |
| :----------- | :----------: | -----------: |
| Выравнивание | Выравнивание | Выравнивание |
| влево        | по центру    | вправо       |
```

Или более компактно

```md
Столбец 1|Столбец 2|Столбец 3
:--|:-:|--:
Выглядит|это|страшновато...
```

Ну вот и всё!

За более подробной информацией обращайтесь к [статье](http://daringfireball.net/projects/markdown/syntax) Джона Грубера о синтаксисе Markdown.

Также часто бывает полезной отличная ["шпаргалка"](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) по Markdown от Адама Притчарда.