Sha256: 9c9d370e3492d1d2e6c040dafbbcc94041be4207afa51da44af262227f556eda
Contents?: true
Size: 1.06 KB
Versions: 28
Compression:
Stored size: 1.06 KB
Contents
# GitHub Markdown Rendering class
#
# Provides a Markdown rendering method as a singleton, and two
# auxiliary functions
#
# There are two kinds of Markdown in GitHub.com:
#
# - Plain Markdown: used in Wikis, Pages and GitHub::Markup (READMEs).
# This is standards-compliant Markdown, with some of the PHP-Markdown
# extensions:
#
# - GitHub-flavored Markdown: used in user-input text, such as comments.
# Same extensions as Plain Markdown, and additionally the following
# extensions:
#
# GitHub::Markdown.render(content)
# #=> Rendered Markdown as HTML plaintext with the default extensions
#
# GitHub::Markdown.render_gfm(content)
# #=> Rendered GitHub-flavored Markdown as HTML plaintext
#
# GitHub::Markdown._to_html(content, mode) { |code, lang| ... }
# #=> Rendered Markdown with the given mode as HTML plaintext
module GitHub
class Markdown
def self.render(content)
self.to_html(content, :markdown)
end
def self.render_gfm(content)
self.to_html(content, :gfm)
end
end
end
# Load the actual C extension
require 'github/markdown.so'
Version data entries
28 entries across 27 versions & 2 rubygems