Markdown tutorial

Markdown – это простой язык разметки, разработанный для облегчения написания HTML в обычном текстовом редакторе. Основное удобство markdown в том, что пользователю не нужно писать массы HTML-специфичных символов (например, символы «<» и «>»). Данное руководство содержит пошаговые инструкции освоения markdown.

Базовые принципы

Первое что нужно знать о markdown – различные элементы текста (абзацы, списки, участки кода) отделяются друг от друга двойным разрывом строки. Соответственно, при написании текста в редакторе, для начала нового абзаца нужно просто два раза нажать ENTER.

Простое форматирование

Простейшее видоизменение шрифта в markdown осуществляется заключением текста в пару специальных символов:

Markdown	Результат	Клавиши редактора	Видоизменение
текст	Текст	Ctrl+I	Курсив
текст	Текст	Ctrl+B	Полужирный текст

При наборе в редакторе можно использовать соответствующие горячие клавиши.

Заголовки

Заголовки начинаются с нескольких символов «#». Уровень заголовка определяется количеством этих символов. В тексте постов допустимы только заголовки с 3-го по 6-й уровень:

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

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

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

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

Блоки кода

Многострочные участки кода выделяются в отдельный блок (отделяются двойным разрывом строки). Каждая строка кода должна начинаться с четырех пробелов. Если вы вставляете код в редактор, то для форматирования выделите его и нажмите Ctrl+K. При этом к каждой строке будет автоматически добавлено по четыре пробела. Если код должен быть расположен внутри текста и не нуждается в подсветке, то такой код нужно заключить в пару символов «`» или воспользоваться тем же сочетанием клавиш – Ctrl+K.

Ссылки

Сылки создаются следующим образом:

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

Пример:

[Повторное использование знаний](http://codehelper.ru "Code Helper")

Можно вынести адрес и заголовок ссылки в любое место страницы:

[Текст ссылки][тег]
В любом месте документа определяется тег:
[тег]: адрес://ссылки.здесь "Заголовок ссылки"

В редакторе можно выделить текст, который нужно преобразовать в ссылку, и нажать Ctrl+L.

Рисунки

Для создания рисунка нужно набрать текст:

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

Или использовать горячие клавиши Ctrl+G.

Цитаты

Цитаты начинаются со знака >

> Этот текст будет оформлен в виде цитаты.

Списки

Markdown позволяет создавть маркированные и нумерованные списки произвольной вложенности. Элементы маркированного списка должны начинаться со специального символа (любой из набора: *, +, -). Уровень вложенности определяется отступом элемента относительно родительского:

- Элемент1
- Элемент2
    + Элемент2.1
    + Элемент2.2
        + Элемент2.2.1
        + Элемент2.2.2
- Элемент3
- Элемент4

Элементы нумерованного списка начинаются с цифры. При этом сама цифра не является номером элемента, а просто указывает на принадлежность к списку:

1. Элемент1
1. Элемент2
1. Элемент3
2. Элемент3

Дополнительные возможности

CodeHelper использует некоторые дополнительные правила для расширения синтаксиса markdown.

Специальные символы

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

Markdown	Результат
--	—
-->	→
<--	←
<-->	↔

Code Highlighting

Code Highlighting — это возможность выделять значимый участок в многострочном участке кода. Можно указать текстовое описание, которое будет отображаться как всплывающая подсказка.

Синтаксис: ^^выделенный код|необязательная подсказка^^

Пример:

public static void ^^Main|Обратите внимание на этот метод^^(){}

Результат:

public static void Main(){}

Code Bullet-point

Code Bullet-point позволяет расставлять внутри блоков кода нумерованые аннотации. Аннотация может содержать текст подсказки и последующее текстовое описание вне кода.

Синтаксис bullet-point внутри кода:

/*|n-необязательная подсказка|*/, где n — порядковый номер аннотации.

Синтаксис описания bullet-point вне кода:

|n| любое текстовое описанние

Пример использования. Исходный текст:

Пример программы Hello World на Java
        
        public class HelloWorld {                    /*|1-Объявление класса|*/
            public static void ^^main^^(String[] ^^args|Это аргументы^^) {
                System.out.println("Hello, World!"); /*|2|*/
            }
        }

    |1| — Объявление класса.

    |2| — Вывод сообщения на консоль.

Результат:

Пример программы Hello World на Java
public class HelloWorld {                    1
    public static void main(String[] args) {
        System.out.println("Hello, World!"); 2

    }
}
1 — Объявление класса.

2 — Вывод сообщения на консоль.