lib/github_api/markdown.rb
# 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"
#
Render an arbritrary Markdown document
Parameters
:text - Required string - The Markdown text to render
:mode - Optional string - The rendering mode
markdown to render a document as plain Markdown, just
like README files are rendered.
gfm 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.
:context - Optional string - The repository context, only taken
into account when rendering as gfm


Render an arbritrary Markdown document Parameters : text - Required string - The Markdown text to render : mode - Optional string - The rendering mode markdown to render a document as plain Markdown just like README files are rendered . gfm 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 . : context - Optional string - The repository context only taken into account when rendering as gfm
def render(*args)
      params = args.extract_options!
      normalize! params
      assert_required_keys ['text'], params
      post_request("markdown", params, :raw => true)
    end
def render ( * args ) params = args . extract_options! normalize! params assert_required_keys [ 'text' ] , params post_request ( "markdown" , params , :raw => true ) end
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.
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 .
args
<not_specific>