❗ Вебсайт в стадии бета-тестирования. Возможны ошибки.
Справочники
Инженерия
Goldmark
Символы

Символы разметки Goldmark

Кодировка

Важно!

Оформляйте текст в нотации Goldmark только в кодировке UTF-8!

Для того, чтобы объявить о том, что вебстраница в кодировке UTF-8, в метаданные вебстраницы следует включить строку:

<meta charset="utf-8">

Символы синтаксиса

Язык Goldmark содержит специальные символы, предназначенные для разметки строк гипертекста.

Назначение символов языка разметки Goldmark:

  • решётка, хэш (#) — используют для разметки заголовков (h1 … h4);
  • подчёркивание (_) — с начала строки для разметки горизональной линии, в середине строки для разметки курсива (тег <em>);
  • звёздочка (*) — для разметки важности строки (тег <strong>)
  • тильда (~) — в начале строки для указания на блок кода, в середине строки для разметки зачёркнутой строки;
  • дефис (-) — для разметки ненумерованного списка;
  • точка (.) — для разметки нумерованного списка;
  • знак меньше (>) — для начала цитаты;
  • обратная кавычка (`) — для разметки блока кода;
  • квадратные скобки [ ] — для разметки изображений, ссылок, сносок;
  • круглые скобки ( ) — для разметки изображений и ссылок;
  • угловые скобки < > — для разметки URL;
  • вертикальный символ (|) — для разметки таблицы;
  • двоеточие (:) — для разметки определений и равнения строк таблицы;
  • акцент (^) — для указания на надстрочный индекс.

Пробел, табуляция и пустая строка играют решающую роль в разметке.

Внимание!

Учитывайте, что табуляция представляет собой четыре пробела. Это крайне важно при разметке списков и фрагментов программного кода.

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

Экранирование

Экранировать следует как разметку в формате Goldmark, так и в формате HTML (если она включена в текст).

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

В случае, если текст основного содержания содержит один из символов разметки, его следует экранировать. В противном случае любой из управляющих символов может сработать как разметка и приведёт к ошибке на вебстранице. Для экранирования следует перед символом поместить обратную косую черту (\).

\\      (backslash) обратная косая черта;
\`      (backtick) обратная кавычка;
\*      (asterisk) звёздочка;
\_      (underscore) подчёркивание;
\{ \}   (curly braces) фигурные скобки;
\[ \]   (square brackets) квадратные скобки;
\( \)   (parentheses) круглые скобки;
\#      (hash) решётка;
\~      (tilde) тильда.

Пример экранирования символов разметки в основном тексте:

Пример обратной косой черты \\ в строке текста.

\[Пример текста в квадратных скобках\].
<p>Пример обратной косой черты \ в строке текста.</p>
<p>[Пример текста в квадратных скобках].</p>

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

В случае, если в структуре текста, размеченного по правилам языка Goldmark, включены фрагменты с разметкой HTML, следует применять правила экранирования.

Подсказка

Подробно об экранировании символов HTML изложено в разделе «Символы».

Типографские сокращения

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

В языке Goldmark модуль extension.Typographer преобразует символы ASCII в типографские символы языка HTML. По умолчанию происходит подстановка:

  • пары одинарных кавычек (’ ‘) в &lsquo;, &rsquo;
  • пары двойных кавычек (" “) в &ldquo;, &rdquo;
  • двух дефисов (–) в короткое тире –`
  • трёх дефисов (---) в длинное тире &mdash;
  • трёх точек (...) в горизонтальное многоточие &hellip;
  • двух знаков меньше (<<) в левую ёлочку &laquo;
  • двух знаков больше (>>) в правую ёлочку &raquo;.
НазначениеСноска