Sha256: a77e09a1657ad98ee86308e556432242ec4847754f76f63e14b2e7fbc30dde98

Contents?: true

Size: 747 Bytes

Versions: 10

Compression:

Stored size: 747 Bytes

Contents

module Octokit
  class Client
    module Markdown

      # Receive the default Readme for a repository
      #
      # @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 => "pengwynn/octokit")
      def markdown(text, options={})
        options[:text] = text
        options[:repo] = Repository.new(options[:repo]) if options[:repo]
        post("markdown", options, 3, true, true).body
      end

    end
  end
end

Version data entries

10 entries across 10 versions & 1 rubygems

Version Path
octokit-1.18.0 lib/octokit/client/markdown.rb
octokit-1.17.1 lib/octokit/client/markdown.rb
octokit-1.17.0 lib/octokit/client/markdown.rb
octokit-1.15.1 lib/octokit/client/markdown.rb
octokit-1.15.0 lib/octokit/client/markdown.rb
octokit-1.14.0 lib/octokit/client/markdown.rb
octokit-1.13.0 lib/octokit/client/markdown.rb
octokit-1.12.0 lib/octokit/client/markdown.rb
octokit-1.11.0 lib/octokit/client/markdown.rb
octokit-1.10.0 lib/octokit/client/markdown.rb