diff options
| author | Achilleas Pipinellis <axil@gitlab.com> | 2019-01-15 13:20:52 +0000 |
|---|---|---|
| committer | Achilleas Pipinellis <axil@gitlab.com> | 2019-01-15 13:20:52 +0000 |
| commit | cbad001c109d886e47df70ca3f2e6382e4130f5e (patch) | |
| tree | 78f43a8eeaba476726f0e982b29b8cbe26449c47 | |
| parent | 09d9b11513cfefcfc281f2f85526316fb368d8f2 (diff) | |
| parent | ca74ba977718a8a72de4fa3cf444a9147a894e41 (diff) | |
| download | gitlab-ce-cbad001c109d886e47df70ca3f2e6382e4130f5e.tar.gz | |
Merge branch 'docs/guidance-for-four-backticks' into 'master'
Document four backticks feature in markdown
See merge request gitlab-org/gitlab-ce!24349
| -rw-r--r-- | doc/development/documentation/styleguide.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 15363b4750c..092bbdac037 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -284,8 +284,14 @@ Inside the document: ```md Markdown code ``` + + ```text + Code for which no specific highlighting class is available. + ``` ```` +- To display raw markdown instead of rendered markdown, use four backticks on their own lines around the + markdown to display. See [example](https://gitlab.com/gitlab-org/gitlab-ce/blob/8c1991b9bb7e3b8d606481fdea316d633cfa5eb7/doc/development/documentation/styleguide.md#L275-287). - For a complete reference on code blocks, check the [Kramdown guide](https://about.gitlab.com/handbook/product/technical-writing/markdown-guide/#code-blocks). ## Alert boxes |