Markdown
MarkdownAPIを使うと、MarkdownドキュメントをHTMLページあるいは生のテキストとしてレンダリングできます。
Render a Markdown document
パラメータ
Headers |
---|
名前, 種類, 説明 |
accept stringSetting to |
Body parameters |
名前, 種類, 説明 |
text string必須The Markdown text to render in HTML. |
mode stringThe rendering mode. Can be either デフォルト: Can be one of: |
context stringThe repository context to use when creating references in |
HTTP response status codes
Status code | 説明 |
---|---|
200 | OK |
304 | Not modified |
コードサンプル
curl \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: token <TOKEN>" \
https://HOSTNAME/api/v3/markdown
Response
Status: 200
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.
HTTP response status codes
Status code | 説明 |
---|---|
200 | OK |
304 | Not modified |