Sha256: 3a23a672cb50aafa41ae16b99066f4b105f7d439572815e032dc00a549dbb5af
Contents?: true
Size: 937 Bytes
Versions: 24
Compression:
Stored size: 937 Bytes
Contents
# frozen_string_literal: true
module Octokit
class Client
# Methods for the Markdown API
#
# @see https://developer.github.com/v3/markdown/
module Markdown
# Render an arbitrary Markdown document
#
# @param text [String] Markdown source
# @option options [String] (optional) :mode (`markdown` or `gfm`)
# @option options [String] (optional) :context Repo context
# @return [String] HTML renderization
# @see https://developer.github.com/v3/markdown/#render-an-arbitrary-markdown-document
# @example Render some GFM
# Octokit.markdown('Fixed in #111', :mode => "gfm", :context => "octokit/octokit.rb")
def markdown(text, options = {})
options[:text] = text
options[:repo] = Repository.new(options[:repo]) if options[:repo]
options[:accept] = 'application/vnd.github.raw'
post 'markdown', options
end
end
end
end
Version data entries
24 entries across 24 versions & 2 rubygems