Class: Github::Markdown

Inherits:
API
  • Object
show all
Defined in:
lib/github_api/markdown.rb

Constant Summary

Constants included from Request

Request::METHODS, Request::METHODS_WITH_BODIES

Constants included from Connection

Connection::ALLOWED_OPTIONS

Constants included from Constants

Constants::ACCEPT, Constants::ACCEPTED_OAUTH_SCOPES, Constants::ACCEPT_CHARSET, Constants::CACHE_CONTROL, Constants::CONTENT_LENGTH, Constants::CONTENT_TYPE, Constants::DATE, Constants::ETAG, Constants::HEADER_LAST, Constants::HEADER_LINK, Constants::HEADER_NEXT, Constants::LOCATION, Constants::META_FIRST, Constants::META_LAST, Constants::META_NEXT, Constants::META_PREV, Constants::META_REL, Constants::OAUTH_SCOPES, Constants::PARAM_PAGE, Constants::PARAM_PER_PAGE, Constants::PARAM_START_PAGE, Constants::RATELIMIT_LIMIT, Constants::RATELIMIT_REMAINING, Constants::SERVER, Constants::USER_AGENT

Constants included from MimeType

Github::MimeType::MEDIA_LOOKUP

Instance Attribute Summary

Attributes inherited from API

#current_options

Attributes included from Authorization

#scopes

Instance Method Summary collapse

Methods inherited from API

#api_methods_in, #append_arguments, #arguments, inherited, #initialize, #method_missing, #process_basic_auth, #set, #setup, #with, #yield_or_eval

Methods included from RateLimit

#ratelimit, #ratelimit_remaining

Methods included from Request

#delete_request, #get_request, #patch_request, #post_request, #put_request, #request

Methods included from Connection

#caching?, #clear_cache, #connection, #default_middleware, #default_options, #stack

Methods included from MimeType

#lookup_media, #parse

Methods included from Authorization

#auth_code, #authenticated?, #authentication, #authorize_url, #basic_authed?, #client, #get_token

Constructor Details

This class inherits a constructor from Github::API

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Github::API

Instance Method Details

#render(*args) ⇒ Object

Render an arbritrary Markdown document

Parameters

<tt>:text</tt> - Required string - The Markdown text to render
<tt>:mode<tt> - Optional string - The rendering mode
  * <tt>markdown</tt> to render a document as plain Markdown, just
                      like README files are rendered.
  * <tt>gfm</tt> to render a document as user-content, e.g. like user
    comments or issues are rendered. In GFM mode, hard line breaks are
    always taken into account, and issue and user mentions are
    linked accordingly.
<tt>:context<tt> - Optional string - The repository context, only taken
                   into account when rendering as <tt>gfm</tt>

Examples

github = Github.new
github.markdown.render
  "text": "Hello world github/linguist#1 **cool**, and #1!",
  "mode": "gfm",
  "context": "github/gollum"



27
28
29
30
31
32
33
34
35
 
# File 'lib/github_api/markdown.rb', line 27

def render(*args)
  arguments(args) do
    assert_required ['text']
  end
  params = arguments.params
  params['raw'] = true

  post_request("markdown", arguments.params)
end

#render_raw(*args) ⇒ Object

Render a Markdown document in raw mode

Input

The raw API it not JSON-based. It takes a Markdown document as plaintext
<tt>text/plain</tt> or <tt>text/x-markdown</tt> and renders it as plain
Markdown without a repository context (just like a README.md file is
rendered – this is the simplest way to preview a readme online)

Examples

github = Github.new
github.markdown.render_raw "Hello github/linguist#1 **cool**, and #1!",
  "accept": "text/plain",



50
51
52
53
54
55
56
57
 
# File 'lib/github_api/markdown.rb', line 50

def render_raw(*args)
  params = arguments(args).params
  mime_type, params['data'] = params['mime'], args.shift
  params['raw'] = true
  params['accept'] = params.fetch('accept') { 'text/plain' }

  post_request("markdown/raw", params)
end