markdown

Documentation

Index

• type Client
  • func NewClient(opt ...requests.Option) Client
  • func (c Client) Render(ctx context.Context, req *RenderReq, opt ...requests.Option) (*RenderResponse, error)
  • func (c Client) RenderRaw(ctx context.Context, req *RenderRawReq, opt ...requests.Option) (*RenderRawResponse, error)
• type RenderRawReq
  • func (r *RenderRawReq) HTTPRequest(ctx context.Context, opt ...requests.Option) (*http.Request, error)
  • func (r *RenderRawReq) Rel(link string, resp *RenderRawResponse) bool
• type RenderRawResponse
  • func RenderRaw(ctx context.Context, req *RenderRawReq, opt ...requests.Option) (*RenderRawResponse, error)
  • func (r *RenderRawResponse) HTTPResponse() *http.Response
  • func (r *RenderRawResponse) ReadResponse(resp *http.Response) error
• type RenderReq
  • func (r *RenderReq) HTTPRequest(ctx context.Context, opt ...requests.Option) (*http.Request, error)
  • func (r *RenderReq) Rel(link string, resp *RenderResponse) bool
• type RenderReqBody
• type RenderResponse
  • func Render(ctx context.Context, req *RenderReq, opt ...requests.Option) (*RenderResponse, error)
  • func (r *RenderResponse) HTTPResponse() *http.Response
  • func (r *RenderResponse) ReadResponse(resp *http.Response) error

Types

type Client

type Client []requests.Option

Client is a set of options to apply to requests

func NewClient

func NewClient(opt ...requests.Option) Client

NewClient returns a new Client

func (Client) Render

func (c Client) Render(ctx context.Context, req *RenderReq, opt ...requests.Option) (*RenderResponse, error)

Render performs requests for "markdown/render"

Render a Markdown document.

POST /markdown

https://developer.github.com/v3/markdown/#render-a-markdown-document

Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.

func (Client) RenderRaw

func (c Client) RenderRaw(ctx context.Context, req *RenderRawReq, opt ...requests.Option) (*RenderRawResponse, error)

RenderRaw performs requests for "markdown/render-raw"

Render a Markdown document in raw mode.

POST /markdown/raw

https://developer.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode

Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.

type RenderRawReq

type RenderRawReq struct {

	// http request's body
	RequestBody io.Reader
	// contains filtered or unexported fields
}

RenderRawReq is request data for Client.RenderRaw

https://developer.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode

Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.

func (*RenderRawReq) HTTPRequest

func (r *RenderRawReq) HTTPRequest(ctx context.Context, opt ...requests.Option) (*http.Request, error)

HTTPRequest builds an *http.Request. Non-nil errors will have the type *requests.RequestError.

func (*RenderRawReq) Rel

func (r *RenderRawReq) Rel(link string, resp *RenderRawResponse) bool

Rel updates this request to point to a relative link from resp. Returns false if the link does not exist. Handy for paging.

type RenderRawResponse

type RenderRawResponse struct {
	// contains filtered or unexported fields
}

RenderRawResponse is a response for RenderRaw

https://developer.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode

func RenderRaw

func RenderRaw(ctx context.Context, req *RenderRawReq, opt ...requests.Option) (*RenderRawResponse, error)

RenderRaw performs requests for "markdown/render-raw"

Render a Markdown document in raw mode.

POST /markdown/raw

https://developer.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode

func (*RenderRawResponse) HTTPResponse

func (r *RenderRawResponse) HTTPResponse() *http.Response

HTTPResponse returns the *http.Response

func (*RenderRawResponse) ReadResponse

func (r *RenderRawResponse) ReadResponse(resp *http.Response) error

ReadResponse reads an *http.Response. Non-nil errors will have the type octo.ResponseError.

type RenderReq

type RenderReq struct {
	RequestBody RenderReqBody
	// contains filtered or unexported fields
}

RenderReq is request data for Client.Render

https://developer.github.com/v3/markdown/#render-a-markdown-document

Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.

func (*RenderReq) HTTPRequest

func (r *RenderReq) HTTPRequest(ctx context.Context, opt ...requests.Option) (*http.Request, error)

HTTPRequest builds an *http.Request. Non-nil errors will have the type *requests.RequestError.

func (*RenderReq) Rel

func (r *RenderReq) Rel(link string, resp *RenderResponse) bool

Rel updates this request to point to a relative link from resp. Returns false if the link does not exist. Handy for paging.

type RenderReqBody

type RenderReqBody struct {

	// The repository context to use when creating references in `gfm` mode.
	Context *string `json:"context,omitempty"`

	// The rendering mode.
	Mode *string `json:"mode,omitempty"`

	// The Markdown text to render in HTML.
	Text *string `json:"text"`
}

RenderReqBody is a request body for markdown/render

https://developer.github.com/v3/markdown/#render-a-markdown-document

type RenderResponse

type RenderResponse struct {
	// contains filtered or unexported fields
}

RenderResponse is a response for Render

https://developer.github.com/v3/markdown/#render-a-markdown-document

func Render

func Render(ctx context.Context, req *RenderReq, opt ...requests.Option) (*RenderResponse, error)

Render performs requests for "markdown/render"

Render a Markdown document.

POST /markdown

https://developer.github.com/v3/markdown/#render-a-markdown-document

func (*RenderResponse) HTTPResponse

func (r *RenderResponse) HTTPResponse() *http.Response

HTTPResponse returns the *http.Response

func (*RenderResponse) ReadResponse

func (r *RenderResponse) ReadResponse(resp *http.Response) error

ReadResponse reads an *http.Response. Non-nil errors will have the type octo.ResponseError.