diff options
| author | blackst0ne <blackst0ne.ru@gmail.com> | 2018-05-18 19:22:45 +1100 |
|---|---|---|
| committer | blackst0ne <blackst0ne.ru@gmail.com> | 2018-05-18 19:22:45 +1100 |
| commit | 719a7d8f6c1b2284679db808bee05ed25705aa47 (patch) | |
| tree | 502810d53467948e8ab2eaad3e954545dfb686c1 | |
| parent | 48a3202d4dadb444116b2572877364c764de31d0 (diff) | |
| download | gitlab-ce-19861-expand-api-render-an-arbitrary-markdown-document.tar.gz | |
Update docs [ci skip]19861-expand-api-render-an-arbitrary-markdown-document
| -rw-r--r-- | doc/api/markdown.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/api/markdown.md b/doc/api/markdown.md index e93e6c2fbfb..f406838e887 100644 --- a/doc/api/markdown.md +++ b/doc/api/markdown.md @@ -14,7 +14,7 @@ POST /api/v4/markdown | --------- | ------- | ------------- | ------------------------------------------ | | `text` | string | yes | The markdown text to render | | `gfm` | boolean | no (optional) | Render text using GitLab Flavored Markdown. Default is `false` | -| `project` | string | no (optional) | Use `project` as a context when creating references using GitLab Flavored Markdown. `PRIVATE-TOKEN` is required if a project is not public. | +| `project` | string | no (optional) | Use `project` as a context when creating references using GitLab Flavored Markdown. [Authentication](README.html#authentication) is required if a project is not public. | ```bash curl --header Content-Type:application/json --data '{"text":"Hello world! :tada:", "gfm":true, "project":"group_example/project_example"}' https://gitlab.example.com/api/v4/markdown @@ -22,8 +22,8 @@ curl --header Content-Type:application/json --data '{"text":"Hello world! :tada: Response example: -``` -{ "html": "<p dir="auto">Hello world! <gl-emoji title="party popper" data-name="tada" data-unicode-version="6.0">🎉</gl-emoji></p>" } +```json +{ "html": "<p dir=\"auto\">Hello world! <gl-emoji title=\"party popper\" data-name=\"tada\" data-unicode-version=\"6.0\">🎉</gl-emoji></p>" } ``` [ce-18926]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/18926 |