Шпаргалка по Markdown

1965

Введение

Markdown- это инструмент преобразования текста в HTML код. Markdown позволяет писать легко читаемый текст, а затем преобразовать его в структурно валидный XHTML (или HTML).

Таким образом, “Markdown” обьединяет в себе две вещи:

  1. понятный синтаксис форматирования текста
  2. программный инструмент, написанный на Perl, который преобразует простой текст в HTML.

Первостепенной целью разработки Markdown является сделать его синтаксис максимально читаемым. Идея заключается в том, что форматированный с помощью Markdown документ должен быть опубликованию как есть, как обычный текст, не глядя, как он был помечен тегами или инструкциями форматирования. Хотя синтаксис markdown существует для преобразования текста в HTML, основным источником вдохновения для синтаксиса markdown является формат обычного текста отправляемого по электронной почте.

Эта статья предназначена в качестве краткого справочника. Для получения более полной информации смотрите оригинальную спецификацию Джона Грубера.

Заголовки

# H1
## H2
### H3
#### H4
##### H5
###### H6

H1
======

H2
------

Выделение

Акцент, он же курсив с помощью *звездочек* или _подчеркивания_

Сильный акцент, он же жирный, с помощью **двух звездочек** или __двух подчеркиваний__

Комбинированно с **двумя звездочками и _подчеркиванием_**

Зачеркивание реализуется с помощью двух ~~тильд~~

Акцент, он же курсив с помощью звездочек или подчеркивания

Сильный акцент, он же жирный, с помощью двух звездочек или двух подчеркиваний

Комбинированно с двумя звездочками и подчеркиванием

Зачеркивание реализуется с помощью двух тильд

Списки

1. Первый пункт нумерованного списка
2. Еще один пункт
 * Ненумерованный подсписок. 
1. Реальные цифры не имеют значения, должно быть понятно что это количество
 1. Упорядоченный подсписок
4. И еще один пункт.

   Вы можете управлять отступом абзацев в элементах списка. Обратите внимание на пустые строки, и пробелы.

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

* Неупорядоченный список можно использовать звездочки
- Или минусы
+ Или плюсы
  1. Первый пункт нумерованного списка
  2. Еще один пункт
    • Ненумерованный подсписок.
  3. Реальные цифры не имеют значения, должно быть понятно что это количество
    1. Упорядоченный подсписок
  4. И еще один пункт.

    Вы можете управлять отступом абзацев в элементах списка. Обратите внимание на пустые строки, и пробелы.

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

  • Неупорядоченный список можно использовать звездочки
  • Или минусы
  • Или плюсы

Ссылки

[Я инлайн ссылка](https://zencod.ru)

[Я инлайн ссылка с названием](https://zencod.ru "главная страница")

[Я ссылка с указателем ссылки][любой текст]

[Я относительная ссылка на хранилище файлов](../i)

[Вы можете использовать цифры для определения указателей ссылки][1]

Или оставить его пустым и использовать сам [Текст ссылки].

URL-адреса и URL с угловыми скобками автоматически преобразуются в ссылки. 
https://zencod.ru или <https://zencod.ru>.

Некоторый текст, чтобы показать, что ссылки могут находиться внизу.

[любой текст]: https://zencod.ru
[1]: http://zencod.ru
[Текст ссылки]: http://zencod.ru

Я инлайн ссылка

Я инлайн ссылка с названием

Я ссылка с указателем ссылки

Я относительная ссылка на хранилище файлов

Вы можете использовать цифры для определения указателей ссылки

Или оставить его пустым и использовать сам Текст ссылки.

URL-адреса и URL с угловыми скобками автоматически преобразуются в ссылки. https://zencod.ru или https://zencod.ru.

Некоторый текст, чтобы показать, что ссылки могут находиться внизу.

Изображения

Вот картинка (наведите, чтобы увидеть текст заголовка):

Инлайн: 
![Alt-текст 1](//yastatic.net/www/_/_/i/tLI86LIriNsIJwhEqZS2o1Ckk.png "Заголовок 1")

С указателем на изображение: 
![Alt текст 2][логотип]

[логотип]: //yastatic.net/www/_/_/i/tLI86LIriNsIJwhEqZS2o1Ckk.png "Заголовок 2"

Вот картинка (наведите, чтобы увидеть текст заголовка):

Инлайн: Alt-текст 1

С указателем на изображение: Alt текст 2

Код и синтаксис подсветки

Для подсветки синтаксиса кода рекомендуется использовать highlight.js

Для отображения блоков кода, оберните код тремя обратными апострофами```, или используйте отступ в четыре пробела. Я рекомендую использовать только с помощью трех обратных апострофов, это легче использовать и только они поддерживают подсветку синтаксиса.


```javascript
var s = "JavaScript syntax highlighting";
alert(s);
```

```python
s = "Python syntax highlighting"
print s
```

Результат:

var s = "JavaScript syntax highlighting";
alert(s);
s = "Python syntax highlighting"
print s

Таблицы

| текст         | текст              | текст |
| ------------- |:------------------:| -----:|
| столбец 1     | текст              | $1600 |
| столбец 2     | текст              |   $12 |
| столбец 3     | текст              |    $1 |
текст текст текст
столбец 1 текст $1600
столбец 2 текст $12
столбец 3 текст $1

Цитаты

> Так выглядит цитата.
> Продолжение цитаты.

Разрыв цитаты.

> Еще одна цитата

Так выглядит цитата. Продолжение цитаты.

Разрыв цитаты.

Еще одна цитата

Инлайн HTML

<dl>
  <dt>Заголовок написанный внутри тегов</dt>
  <dd>Пример вставки текста в теге</dd>
</dl>
Заголовок написанный внутри тегов
Пример вставки текста в теге

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

Три и более...

---

Дефисы

***

Звездочки

___

Подчеркивания

Три и более...


Дефисы


Звездочки


Подчеркивания