Skip to content

Commit c0dec14

Browse files
committed
Convert misc
1 parent 3aa7c72 commit c0dec14

2 files changed

Lines changed: 14 additions & 20 deletions

File tree

content/v3/markdown.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,15 @@ title: Markdown Rendering | GitHub API
1111

1212
POST /markdown
1313

14-
### Input
14+
### Parameters
1515

16-
text
17-
: _Required_ **string** - The Markdown text to render
16+
Name | Type | Description | Required? | Default
17+
----|------|--------------|-----------|---------
18+
`text`|`string` | The Markdown text to render|**YES**|
19+
`mode`|`string` | The rendering mode. Can be either:<br/>* `markdown` to render a document as plain Markdown, just like README files are rendered. <br/>* `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.| |
20+
`context`|`string` | The repository context. Only taken into account when rendering as `gfm`| |
1821

19-
mode
20-
: _Optional_ **string** - The rendering mode
21-
22-
- `markdown` to render a document as plain Markdown, just like README files are rendered.
23-
- `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.
24-
25-
context
26-
: _Optional_ **string** - The repository context, only taken into account when rendering as `gfm`
22+
#### Example
2723

2824
<%= json \
2925
:text => "Hello world github/linguist#1 **cool**, and #1!",
@@ -41,7 +37,7 @@ context
4137

4238
POST /markdown/raw
4339

44-
### Input
40+
### Parameters
4541

4642
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).
4743

content/v3/meta.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,9 @@ This gives some information about GitHub.com, the service.
1515

1616
### Body
1717

18-
hooks
19-
: An Array of IP addresses in CIDR format specifying the addresses that incoming
20-
service hooks will originate from. Subscribe to the [API Changes blog](http://developer.github.com/changes/)
21-
or follow [@GitHubAPI](https://twitter.com/GitHubAPI) on Twitter to get
22-
updated when this list changes.
23-
24-
git
25-
: An Array of IP addresses in CIDR format specifying the Git servers at GitHub.
18+
Name | Type | Description
19+
----|------|--------------
20+
`hooks`|`array` of `strings` | An Array of IP addresses in CIDR format specifying the addresses that incoming service hooks will originate from. Subscribe to the [API Changes blog](http://developer.github.com/changes/) or follow [@GitHubAPI](https://twitter.com/GitHubAPI) on Twitter to get updated when this list changes.
21+
`git`|`array` of `strings` | An Array of IP addresses in CIDR format specifying the Git servers at GitHub.
22+
23+

0 commit comments

Comments
 (0)