class Github::Client::Markdown
def render(*args)
"context": "github/gollum"
"mode": "gfm",
"text": "Hello world github/linguist#1 **cool**, and #1!",
github.markdown.render
github = Github.new
= Examples
into account when rendering as gfm
:context - Optional string - The repository context, only taken
linked accordingly.
always taken into account, and issue and user mentions are
comments or issues are rendered. In GFM mode, hard line breaks are
* gfm to render a document as user-content, e.g. like user
like README files are rendered.
* markdown to render a document as plain Markdown, just
:mode - Optional string - The rendering mode
:text - Required string - The Markdown text to render
= Parameters
Render an arbritrary Markdown document
def render(*args) arguments(args) do assert_required ['text'] end params = arguments.params params['raw'] = true post_request("markdown", arguments.params) end