hs.doc.markdown

Поддержка преобразования Markdown в HTML и обычный текст, используемая hs.doc

Этот модуль предоставляет поддержку преобразования GitHub-Flavored-Markdown, используемую hs.doc. Этот модуль является Lua-обёрткой для части C-кода Ruby-гема github-markdown, доступного по адресу https://rubygems.org/gems/github-markdown/versions/0.6.9.

Ruby-gem github-markdown был выбран в качестве базового кода для этого модуля, так как он используется для генерации официального набора документации Hammerspoon Dash.

Часть Lua-обёртки лицензирована по MIT-лицензии командой разработчиков Hammerspoon. Часть C-кода Ruby-гема лицензирована по MIT-лицензии компанией GitHub, Inc.

Обзор API

Функции - API-вызовы, предлагаемые непосредственно расширением

convert

Документация API

Функции

convert

Подпись	`hs.doc.markdown.convert(markdown, [type]) -> output`
Тип	Функция
Описание	Преобразует текст, закодированный в формате Markdown, в HTML или обычный текст.
Параметры	markdown - строка, содержащая входной текст, закодированный с помощью тегов Markdown type - необязательная строка, определяющая параметры преобразования и тип вывода. По умолчанию "gfm". В настоящее время распознаваемые типы: "markdown" - указывает, что вывод должен быть HTML со стандартными расширениями GitHub/Markdown, включенными. "gfm" - указывает, что вывод должен быть HTML с дополнительными расширениями GitHub, включенными. "plaintext" - указывает, что вывод должен быть обычным текстом со стандартными расширениями GitHub/Markdown, включенными.
Возвращаемое значение	представление в формате HTML или обычный текст входного текста, закодированного в Markdown.
Примечания	Стандартные расширения GitHub/Markdown, включённые для всех преобразований: NO_INTRA_EMPHASIS - запрещает выделение внутри слов LAX_SPACING - поддерживает форматирование пробелов, как в Markdown 1.0.0 (т.е. не требует пустой строки между двумя разными блоками в абзаце) STRIKETHROUGH - поддержка зачёркивания с помощью двойных тильд (~) TABLES - поддержка таблиц Markdown FENCED_CODE - поддерживает блочные код-блоки, окружённые тремя обратными тильдами (`) или тремя твидами (~) AUTOLINK - URL-адреса HTTP обрабатываются как ссылки, даже если они не помечены как таковые с помощью тегов Markdown Тип "gfm" также включает следующие расширения: HARD_WRAP - переводы строк заменяются сущностями <br> SPACE_HEADERS - требуют пробела между `#` и именем заголовка (предотвращает конфликты с фильтром проблем)
Источник	extensions/doc/markdown.m строка 167

© 2014–2017 Hammerspoon contributors
Licensed under the MIT License.
https://www.hammerspoon.org/docs/hs.doc.markdown.html