About Blog Tags

Форматирование с помощью markdown

Что это и зачем

Как на писано на оригинальном сайте проекта это инструмент для web писателей :) для преобразования текста в html без изучения синтаксиса html. Синтаксис самого markdown в разы проще и нагляднее. Это не замена html, так как синтаксис markdown покрывает только совсем небольшую часть по форматированию.

Внешние линки на документацию и реализации

Для начала предлагаю посетить замечательный сайт с полной информацией по markdown или оригинальный сайт проекта и wiki-ru

Краткая справка

Ну а для тех, кому лень или жаль своего времени для чтения полной документации напишу коротенькую справку по возможностям этого языка разметки

HTML вставки

элементы <div>, <table>, <pre>, <p> и прочие должны отделяться от текста пустой строкой

текст

<table>
    <tr>
        <td>Foo</td>
    </tr>
</table>

текст

Автоматическое экранирование специальных символов

вводим 4 < 5 получаем 4 &lt; 5 и все в том же духе

Блочные элементы

Параграф и переносы строк

Параграф это одна или более, набранных вами, строк текста, которые разделены одной или более пустыми строками.
Если нужно вставить <br> то достаточно в конце строки перед энтером поставить два или более пробела

Заголовки

Либо так

# This is an H1
## This is an H2
###### This is an H6

либо вот так

This is an H1
=============
This is an H2
-------------

Цитаты

Для вставки цитат нужно воспользоваться >

> Это цитата
> и это ее продолжение

Можно ставить символ > только в начале цитаты то-есть “ленивые” цитаты

> первая строка
вторая строка

Можно использовать цитаты на цитаты

> Первая цитата
> > Вложенная

Также сохраняется форматирование при цитировании

> #Заголовок
> * список
> Пример кода
>    
>    print("Helo world!\n")

Списки

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

 * элемент маркированного списка
 — ещё один элемент не нумерованного списка
 + буллеты элементов могут быть разными

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

1. Элемент нумерованного списка
2. Элемент №2 того же списка
9. Элемент №3 списка — элементы нумеруются по порядку, цифра в начале строки не имеет значения

ну и как ранее можно использовать “ленивые” списки

1. Тоесть ставить 
номер списка

в начале

2. первой
строки

Блоки кода

Для определения какой-то части текста как блока кода достаточно отделить обычный текст от блока кода пустыми строками и вставить в каждую строку кода в начале 4 пробела или 1 таб.
Или использовать символ ` для экранирования

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

используем либо три или более символов *, -, _

Форматирование

Ссылки

[Текст ссылки](адрес://ссылки.здесь "Заголовок ссылки")
[Текст ссылки][тег]
[тег]: адрес://ссылки.здесь "Заголовок ссылки"

Выделения текста

*выделение* (курсив)
**сильное выделение** (полужирное начертание)

Картинки

![Alt-текст](URL изображения "Заголовок изображения")

Прочее

Спец символы

Нужно экранироавать обратным слешем

\*символ звездочки\*

Перечень спецсимолов

\   backslash
`   backtick
*   asterisk
_   underscore
{}  curly braces
[]  square brackets
()  parentheses
#   hash mark
+   plus sign
—   minus sign (hyphen)
.   dot
!   exclamation mark

Автоматические ссылки

markdown автоматически может формировать из введенных вами URL правильные с точки зрения HTML теги: введем <http://example.com/> и получим <a href="http://example.com/">http://example.com/</a>

Итоги

Надеюсь что эта статья поможет быстро начать использовать markdown и будет, возможно, постоянной краткой справкой кому-то.

Добавить пост в: Delicious Reddit Slashdot Digg Technorati Google
(уже: 1)

Комментарии

К этой публикации комментариев нет

Форма комментирования для «Форматирование с помощью markdown»

Обязательное поле. Не больше 30 символов.

Обязательное поле

captcha image Пожалуйста, введите символы, которые вы видите на изображении