View Source GitHub.Markdown (GitHub REST API Client v0.3.1)

Provides API endpoints related to markdown

Link to this section Summary

Functions

Render a Markdown document

Render a Markdown document in raw mode

Link to this section Functions

Link to this function

render(body, opts \\ [])

View Source
@spec render(
  map(),
  keyword()
) :: {:ok, String.t()} | {:error, GitHub.Error.t()}

Render a Markdown document

resources

Resources

Link to this function

render_raw(body, opts \\ [])

View Source
@spec render_raw(
  String.t(),
  keyword()
) :: {:ok, String.t()} | {:error, GitHub.Error.t()}

Render a Markdown document in raw mode

You must send Markdown as plain text (using a Content-Type header of text/plain or text/x-markdown) to this endpoint, rather than using JSON format. In raw mode, GitHub Flavored Markdown is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.

resources

Resources