1. Вступление
  2. Онлайн-редакторы
  3. Заголовки
  4. Форматирование текста
  5. Вставка ссылок и картинок
  6. Списки
  7. Форматирование кода
  8. Цитаты
  9. Обычный HTML

Вступление

Маркдаун — самое удобное и интуитивно понятное для редактирования текста, что можно было встретить в интернете. Его используют СтекОверфлоу и Гитхаб, что уже означает повсеместность формата.

Сам по себе, маркдаун это свод правил для форматирования текста и транслятор в HTML. На данный момент трансляторов существует великое множество, все они поддерживают оригинальный стандарт, но некоторые вносят в свои трансляторы дополнительные возможности.

Например, Крамдаун (используемый в джекиле) создал синтаксис для списка определений dl; а ГФМ (GitHub Flavored Markdown) взял на себя больше и ввёл много крутых особенностей для создания более удобного сервиса.

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


В этой статье, я постарался изложить своё видение на изучение основ маркдауна, и то как я его запомнил.

Код из статьи (её маркдаун-исходник лежит на гитхабе) можно тестировать в онлайн редакторах:

Онлайн-редакторы

Заголовки

Заголовки обособляются хешами (хеш справа для красоты)

## Заголовки ##

От количества хешей зависит уровень заголовка:

# Заголовок первого уровня (<h1/>) #
## Заголовок второго уровня (<h2/>) ##
### Заголовок третьего уровня (<h3/>) ###

Главный заголовок можно не выделять хешами, а подчеркнуть двойной линией:

Погружение в маркдаун
================================================================================

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

Заголовки
--------------------------------------------------------------------------------

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

Абзацы и переносы

Новый абзац в маркдауне определяется по наличию пустой строки перед блоком текста.
Обычные одиночные переносы внутри маркдауна, допустим для поддержания длины строки в 80 символов ни на что не влияют.

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

Точки, это пробелы:
markdown text editing

Стилизация текста

  • Жирный текст**Жирный текст**
  • Курсивный текст*Курсивный текст*
  • Жирный курсивный текст***Жирный курсивный текст***

Горизонтальная линия


Горизонтальная линия в маркдауне до смешного проста

--------------------------------------------------------------------------------

Горизонтальная линия в маркдауне до смешного проста
  • Ссылка на котиков[Ссылка на котиков](http://placekitten.com/)
  • Описание картинки с котиком![Описание картинки с котиком](http://placekitten.com/g/100/20)

В большом тексте удобно вставлять ссылки сносками как в книгах:


**В большом тексте** удобно вставлять ссылки [сносками][1] как в книгах:

----
[1]: http://placekitten.com/ "Cat happens"

Списки

Обычный ненумерованный список

  • один
  • два

      * один
      * два
    

Обычный нумерованный список

  1. один
  2. два

     1. один
     2. два
    

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

Блочное форматирование кода

Для блочного выделения кода достаточно сделать отступ в 4 пробела или один таб. Для такого представления:

<ul class="nav">
    <li><a href="/atom.xml">RSS</a></li>
</ul>

Нужно вставить в редактор такой код

    <ul class="nav">
        <li><a href="/atom.xml">RSS</a></li>
    </ul>

Строчное форматирование кода

Для строчного выделения кода достаточно обернуть в обратные кавычки:

Для строчного выделения `кода` достаточно обернуть в обратные кавычки:

Цитаты

Мы не поможем людям, делая за них то, что они могли бы сделать сами.

> Мы не поможем людям, делая за них то, что они могли бы сделать сами.

Обычный HTML

Если что-то нельзя сделать в маркдауне, то используйте обычный HTML. Допустим так:

<h2 id="books"><a href="#books">
    Книги
</a></h2>