Skip to content

Commit 6b08f76

Browse files
authored
Update README.md
1 parent 7988762 commit 6b08f76

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

Miscellaneous/README.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,14 @@ POST /markdown
1313
|Name|Type|Description|
1414
|----|----|-----------|
1515
|text|string|**Required** The Markdown text to render|
16-
|mode|string|The rendering mode, can be empty or **gfm**. In **gfm** mode, Markdown will be rendered with repository context|
17-
|context|string|The repository context. Only taken into account when rendering mode is **gfm**|
16+
|context|string|The repository context, e.g. `https://github.com/gogs/gogs`|
1817

1918
### Example
2019

2120
```json
2221
{
2322
"text": "Hello world gogs/gogs#1 **cool**, and #1!",
24-
"mode": "gfm",
25-
"context": "gogs/gogs"
23+
"context": "https://github.com/gogs/gogs"
2624
}
2725
```
2826

@@ -33,7 +31,7 @@ Status: 200 OK
3331
Content-Type: text/html
3432
```
3533
```html
36-
<p>Hello world gogs/gogs#1 <strong>cool</strong>, and <a href="https://try.gogs.io/gogs/gogs/issues/1" rel="nofollow">#1</a>!</p>
34+
<p>Hello world <a href="https://try.gogs.io/gogs/gogs/issues/1" rel="nofollow">gogs/gogs#1</a> <strong>cool</strong>, and <a href="https://github.com/gogs/gogs/issues/1" rel="nofollow">#1</a>!</p>
3735
```
3836

3937
### Render a Markdown document in raw mode

0 commit comments

Comments
 (0)