Введение
Введение
Справочник разметки текста Goldmark предназначен авторам текстов, которые не обладают глубокими знаниями и умениями технического редактирования. Справочник представляет собой описание нотации и практики применения языка разметки текста Goldmark. Включает сведения необходимые и достаточные техническому писателю для оформления текстов и подготовки их к последующей публикации в форматах HTML, PDF, LaTeX, ODT, Rich Text и других.
Данный справочник не является переводом официальной спецификации Goldmark, а также не может служить учебником для тех, кто только знакомится с синтаксисом разметки Goldmark. Это именно справочник, предназначенный для того, чтобы время от времени уточнить правила оформления той или иной конструкции текста.
Преимущества
Язык разметки Goldmark:
- Полностью соответствует спецификации языка разметки CommonMark.
- Расширяемый. Имеет много дополнительный модулей: таблицы, списки заданий, списки определений. Позволяет вводить собственный синтаксис для строчных и блочных элементов.
- Производительный, сопоставим с эталонной реализацией cmark, написанной на языке C.
- Надёжный. Протестирован средствами языка Go.
- Зависит только от стандартных библиотек языка Go.
Встроенные модули
В состав языка Goldmark входят следующие встроенные модули:
- extension.Table — разметка таблиц;
- extension.Strikethrough — разметка зачёркнутых строк;
- extension.Linkify — разметка автоссылок;
- extension.TaskList — разметка списка заданий;
- extension.GFM — данный модуль включает таблицы, зачёркивания, ссылки и списки заданий. Однако, данный модуль не позволяет вводить фрагменты кода HTML (Raw HTML) и эмоджи.
- extension.DefinitionList — разметка списка определений;
- extension.Footnote — разметка сноски;
- extension.Typographer — замещает знаки препинания типографскими знаками (smartypants).
Внешние модули
Полный список внешних модулей можно найти на странице разработчика в GitHub.