class Github::Client::Markdown
Public Instance Methods
render(*args)
click to toggle source
Render an arbitrary 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"
# File lib/github_api/client/markdown.rb, line 29 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)
click to toggle source
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",
# File lib/github_api/client/markdown.rb, line 52 def render_raw(*args) params = arguments(args).params params['data'] = args.shift params['raw'] = true params['accept'] = params.fetch('accept') { 'text/plain' } post_request("markdown/raw", params) end