Contents

module Octokit
  class Client

    # Methods for the Markdown API
    #
    # @see http://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 http://developer.github.com/v3/repos/markdown/
      # @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

3 entries across 3 versions & 1 rubygems

Version	Path
octokit-2.1.1	lib/octokit/client/markdown.rb
octokit-2.1.0	lib/octokit/client/markdown.rb
octokit-2.0.0	lib/octokit/client/markdown.rb