### Home Classes Methods

### In Files

- lib/github_api/markdown.rb

### Parent

API

### Methods

- #render
- #render_raw

### Class/Module Index

Quicksearch

- Github
- Github::API
- Github::Activity
- Github::Activity::Events
- Github::Activity::Notifications
- Github::Activity::Starring
- Github::Activity::Watching
- Github::ApiFactory
- Github::Arguments
- Github::Authorization
- Github::Authorizations
- Github::AutoloadHelper
- Github::Client
- Github::Configuration
- Github::Connection
- Github::Constants
- Github::CoreExt
- Github::CoreExt::OrderedHash
- Github::Descendants
- Github::Emojis
- Github::Error
- Github::Error::BadRequest
- Github::Error::ClientError
- Github::Error::Forbidden
- Github::Error::GithubError
- Github::Error::InternalServerError
- Github::Error::InvalidOptions
- Github::Error::NotAcceptable
- Github::Error::NotFound
- Github::Error::RequiredParams
- Github::Error::ServiceError
- Github::Error::ServiceUnavailable
- Github::Error::Unauthorized
- Github::Error::UnknownValue
- Github::Error::UnprocessableEntity
- Github::Error::Validations
- Github::Gists
- Github::Gists::Comments
- Github::GitData
- Github::GitData::Blobs
- Github::GitData::Commits
- Github::GitData::References
- Github::GitData::Tags
- Github::GitData::Trees
- Github::Gitignore
- Github::Issues
- Github::Issues::Assignees
- Github::Issues::Comments
- Github::Issues::Events
- Github::Issues::Labels
- Github::Issues::Milestones
- Github::Jsonable
- Github::Markdown
- Github::Meta
- Github::MimeType
- Github::Normalizer
- Github::Orgs
- Github::Orgs::Members
- Github::Orgs::Teams
- Github::PageIterator
- Github::PageLinks
- Github::PagedRequest
- Github::Pagination
- Github::ParameterFilter
- Github::ParamsHash
- Github::PullRequests
- Github::PullRequests::Comments
- Github::RateLimit
- Github::Repos
- Github::Repos::Collaborators
- Github::Repos::Comments
- Github::Repos::Commits
- Github::Repos::Contents
- Github::Repos::Downloads
- Github::Repos::Forks
- Github::Repos::Hooks
- Github::Repos::Keys
- Github::Repos::Merging
- Github::Repos::PubSubHubbub
- Github::Repos::Statistics
- Github::Repos::Statuses
- Github::Request
- Github::Request::BasicAuth
- Github::Request::Jsonize
- Github::Request::OAuth2
- Github::Resource
- Github::Response
- Github::Response::Header
- Github::Response::Jsonize
- Github::Response::Mashify
- Github::Response::RaiseError
- Github::Response::Xmlize
- Github::ResponseWrapper
- Github::S3Uploader
- Github::Say
- Github::Scopes
- Github::Search
- Github::Users
- Github::Users::Emails
- Github::Users::Followers
- Github::Users::Keys
- Github::Utils
- Github::Utils::Url
- Github::VERSION
- Github::Validations
- Github::Validations::Format
- Github::Validations::Presence
- Github::Validations::Required
- Github::Validations::Token
- Hash

No matching classes.

# Github::Markdown

### Public Instance Methods

render(*args) click to toggle source

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"

    # File lib/github_api/markdown.rb, line 26
    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/markdown.rb, line 49
    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

[Validate]

Generated with the Darkfish Rdoc Generator 2.