markdown

Accessed as client.misc.markdown; the async client mirrors it.

SyncAsync

MiscMarkdown

The misc.markdown namespace.

render(
    *, context: str | None = None, mode: str | None = None, text: str | None = None, wiki: bool | None = None
) -> str

Render a markdown document as HTML.

Parameters:

Name	Type	Description	Default
`context`	`str \| None`	Context to render	`None`
`mode`	`str \| None`	Mode to render (comment, gfm, markdown)	`None`
`text`	`str \| None`	Text markdown to render	`None`
`wiki`	`bool \| None`	Is it a wiki page ?	`None`

Returns:

Type	Description
`str`	MarkdownRender is a rendered markdown document.

Raises:

Type	Description
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: renderMarkdown

render_raw(*, body: str) -> str

Render raw markdown as HTML.

Returns:

Type	Description
`str`	MarkdownRender is a rendered markdown document.

Raises:

Type	Description
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: renderMarkdownRaw

The misc.markdown namespace.

render(
    *, context: str | None = None, mode: str | None = None, text: str | None = None, wiki: bool | None = None
) -> str

Render a markdown document as HTML.

Parameters:

Name	Type	Description	Default
`context`	`str \| None`	Context to render	`None`
`mode`	`str \| None`	Mode to render (comment, gfm, markdown)	`None`
`text`	`str \| None`	Text markdown to render	`None`
`wiki`	`bool \| None`	Is it a wiki page ?	`None`

Returns:

Type	Description
`str`	MarkdownRender is a rendered markdown document.

Raises:

Type	Description
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: renderMarkdown

render_raw(*, body: str) -> str

Render raw markdown as HTML.

Returns:

Type	Description
`str`	MarkdownRender is a rendered markdown document.

Raises:

Type	Description
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: renderMarkdownRaw