# Render a Markdown document

From **GitHub v3 REST API**.

`POST /markdown`

Render a Markdown document

## Request body

- Required: true
### `application/json`

- Type: `object`

```json
{"properties":{"context":{"description":"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.","type":"string"},"mode":{"default":"markdown","description":"The rendering mode. Can be either `markdown` or `gfm`.","enum":["markdown","gfm"],"example":"markdown","type":"string"},"text":{"description":"The Markdown text to render in HTML.","type":"string"}},"required":["text"],"type":"object"}
```

## Responses

### `200`

Response

#### Headers

##### `Content-Length`

- Type: `string`

- Example: `279`

##### `Content-Type`

- Type: `string`

- Example: `text/html`

##### `X-CommonMarker-Version`

- Type: `string`

- Example: `0.17.4`

### `text/html`

- Type: `string`

```json
{"type":"string"}
```

### `304`

Not modified

## Request examples

### cURL

```shell
curl --request POST \
  --url {protocol}://{hostname}/api/v3/markdown \
  --header 'content-type: application/json' \
  --data '{
  "context": "string",
  "mode": "string",
  "text": "string"
}'
```