Markdown
Download SpecRender GitHub flavored markdown
text
string
required
The Markdown text to render in HTML.
mode
string
The rendering mode.
- Default
- "markdown"
- Enum
-
- markdown
- gfm
- Example
- "markdown"
context
string
The repository context to use when creating references in gfm
mode. For example, setting context
to octo-org/octo-repo
will change the text #42
into an HTML link to issue 42 in the octo-org/octo-repo
repository.
Request
{
"text": "Hello **world**"
}
Response
Response
"<p>Hello <strong>world</strong></p>"
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
string
- Content Type
- text/html
Content-Type
string
Content-Length
string
X-CommonMarker-Version
string
Not modified
Empty response
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.
string
- Content Type
- text/plain
string
- Content Type
- text/x-markdown
Request
{
"text": "Hello **world**"
}
{
"text": "Hello **world**"
}
Response
Response
"<p>Hello <strong>world</strong></p>"
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
string
- Content Type
- text/html
X-CommonMarker-Version
string
Not modified
Empty response
Was this page helpful?