| title | Markdown |
|---|
{:toc}
POST /markdown
| Name | Type | Description |
|---|---|---|
text |
string |
Required.The Markdown text to render |
mode |
string |
The rendering mode. Can be either: * markdown to render a document as plain Markdown, just like README files are rendered. * gfm to render a document as user-content, e.g. like user comments or issues are rendered. In GFM mode, hard line breaks are always taken into account, and issue and user mentions are linked accordingly.Default: markdown |
context |
string |
The repository context. Only taken into account when rendering as gfm |
<%= json
:text => "Hello world github-linguist/linguist#1 cool, and #1!",
:mode => "gfm",
:context => "github/gollum"
%>
<%= text_html
%(
Hello world github/linguist#1 cool, and #1!
), 200 %>POST /markdown/raw
The raw API is not JSON-based. It takes a Markdown document as plaintext (text/plain or text/x-markdown) and renders it as plain Markdown without a repository context (just like a README.md file is rendered -- this is the simplest way to preview a readme online).
<%= text_html
%(
Hello world github-linguist/linguist#1 cool, and #1!
), 200 %>