markdown

Last updated 23 days ago

Markdown to HTML and plaintext conversion support used by hs.doc

This module provides Github-Flavored-Markdown conversion support used by hs.doc. This module is a Lua wrapper to the C code portion of the Ruby gem github-markdown, available at https://rubygems.org/gems/github-markdown/versions/0.6.9.

The Ruby gem github-markdown was chosen as the code base for this module because it is the tool used to generate the official Hammerspoon Dash docset.

The Lua wrapper portion is licensed under the MIT license by the Hammerspoon development team. The C code portion of the Ruby gem is licensed under the MIT license by GitHub, Inc.

API Overview

  • Functions - API calls offered directly by the extension

API Documentation

Functions

convert

Signature

hs.doc.markdown.convert(markdown, [type]) -> output

Type

Function

Description

Converts markdown encoded text to html or plaintext.

Parameters

Returns

Notes