From 67a605807d86a0e6f950f63dc79b3319cf2ee30c Mon Sep 17 00:00:00 2001 From: smit_tooned Date: Tue, 9 Oct 2018 10:59:58 +0000 Subject: docs/Tsumitsu Fix render issue in GFM documentation page --- doc/user/img/color_inline_colorchip_render_gfm.png | Bin 0 -> 11534 bytes doc/user/img/math_inline_sup_render_gfm.png | Bin 0 -> 1359 bytes doc/user/img/mermaid_diagram_render_gfm.png | Bin 0 -> 4587 bytes doc/user/img/task_list_ordered_render_gfm.png | Bin 0 -> 6247 bytes doc/user/img/unordered_check_list_render_gfm.png | Bin 0 -> 6207 bytes doc/user/markdown.md | 74 +++++++-------------- 6 files changed, 25 insertions(+), 49 deletions(-) create mode 100644 doc/user/img/color_inline_colorchip_render_gfm.png create mode 100644 doc/user/img/math_inline_sup_render_gfm.png create mode 100644 doc/user/img/mermaid_diagram_render_gfm.png create mode 100644 doc/user/img/task_list_ordered_render_gfm.png create mode 100644 doc/user/img/unordered_check_list_render_gfm.png diff --git a/doc/user/img/color_inline_colorchip_render_gfm.png b/doc/user/img/color_inline_colorchip_render_gfm.png new file mode 100644 index 00000000000..6a8a674d6e0 Binary files /dev/null and b/doc/user/img/color_inline_colorchip_render_gfm.png differ diff --git a/doc/user/img/math_inline_sup_render_gfm.png b/doc/user/img/math_inline_sup_render_gfm.png new file mode 100644 index 00000000000..bf1464457bc Binary files /dev/null and b/doc/user/img/math_inline_sup_render_gfm.png differ diff --git a/doc/user/img/mermaid_diagram_render_gfm.png b/doc/user/img/mermaid_diagram_render_gfm.png new file mode 100644 index 00000000000..3b3eb3a738a Binary files /dev/null and b/doc/user/img/mermaid_diagram_render_gfm.png differ diff --git a/doc/user/img/task_list_ordered_render_gfm.png b/doc/user/img/task_list_ordered_render_gfm.png new file mode 100644 index 00000000000..fdff8a9886c Binary files /dev/null and b/doc/user/img/task_list_ordered_render_gfm.png differ diff --git a/doc/user/img/unordered_check_list_render_gfm.png b/doc/user/img/unordered_check_list_render_gfm.png new file mode 100644 index 00000000000..2e3fb7cbb79 Binary files /dev/null and b/doc/user/img/unordered_check_list_render_gfm.png differ diff --git a/doc/user/markdown.md b/doc/user/markdown.md index fb132f0613b..f9bdaea185b 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -112,8 +112,8 @@ GFM will autolink almost any URL you copy and paste into your text: * https://www.google.com * https://google.com/ * ftp://ftp.us.debian.org/debian/ -* smb://foo/bar/baz -* irc://irc.freenode.net/gitlab +* smb://foo/bar/baz +* irc://irc.freenode.net/gitlab * http://localhost:3000 ### Multiline Blockquote @@ -138,17 +138,13 @@ you can quote that without having to manually prepend `>` to every line! >>> ``` ->>> -If you paste a message from somewhere else - -that - -spans - -multiple lines, - -you can quote that without having to manually prepend `>` to every line! ->>> +
+

If you paste a message from somewhere else

+

that

+

spans

+

multiple lines,

+

you can quote that without having to manually prepend > to every line!

+
### Code and Syntax Highlighting @@ -269,15 +265,15 @@ https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/user/markdown.md#emoji Ubuntu 18.04 (like many modern Linux distros) has this font installed by default. -Sometimes you want to :monkey: around a bit and add some :star2: to your :speech_balloon:. Well we have a gift for you: +Sometimes you want to around a bit and add some to your . Well we have a gift for you: -:zap: You can use emoji anywhere GFM is supported. :v: +You can use emoji anywhere GFM is supported. -You can use it to point out a :bug: or warn about :speak_no_evil: patches. And if someone improves your really :snail: code, send them some :birthday:. People will :heart: you for that. +You can use it to point out a or warn about patches. And if someone improves your really code, send them some . People will you for that. -If you are new to this, don't be :fearful:. You can easily join the emoji :family:. All you need to do is to look up one of the supported codes. +If you are new to this, don't be . You can easily join the emoji . All you need to do is to look up one of the supported codes. -Consult the [Emoji Cheat Sheet](https://www.emojicopy.com) for a list of all supported emoji codes. :thumbsup: +Consult the [Emoji Cheat Sheet](https://www.emojicopy.com) for a list of all supported emoji codes. Most emoji are natively supported on macOS, Windows, iOS, Android and will fallback to image-based emoji where there is lack of support. @@ -286,7 +282,6 @@ On Linux, you can download [Noto Color Emoji](https://www.google.com/get/noto/he Ubuntu 18.04 (like many modern Linux distros) has this font installed by default. - ### Special GitLab References GFM recognizes special references. @@ -356,11 +351,7 @@ You can add task lists to issues, merge requests and comments. To create a task - [ ] Sub-task 3 ``` -- [x] Completed task -- [ ] Incomplete task - - [ ] Sub-task 1 - - [x] Sub-task 2 - - [ ] Sub-task 3 +![alt unordered-check-list-render-gfm](img/unordered_check_list_render_gfm.png) Tasks formatted as ordered lists are supported as well: @@ -371,10 +362,7 @@ Tasks formatted as ordered lists are supported as well: 1. [x] Sub-task 2 ``` -1. [x] Completed task -1. [ ] Incomplete task - 1. [ ] Sub-task 1 - 1. [x] Sub-task 2 +![alt task-list-ordered-render-gfm](img/task_list_ordered_render_gfm.png) Task lists can only be created in descriptions, not in titles. Task item state can be managed by editing the description's Markdown or by toggling the rendered check boxes. @@ -393,7 +381,10 @@ The valid video extensions are `.mp4`, `.m4v`, `.mov`, `.webm`, and `.ogv`. Here's a sample video: -![Sample Video](img/markdown_video.mp4) +
+ +

Sample Video

+
### Math @@ -417,12 +408,11 @@ Example: Becomes: -This math is inline $`a^2+b^2=c^2`$. +This math is inline ![alt text](img/math_inline_sup_render_gfm.png). This is on a separate line -```math -a^2+b^2=c^2 -``` + +
_Be advised that KaTeX only supports a [subset][katex-subset] of LaTeX._ @@ -452,15 +442,7 @@ Examples: Become: -`#F00` -`#F00A` -`#FF0000` -`#FF0000AA` -`RGB(0,255,0)` -`RGB(0%,100%,0%)` -`RGBA(0,255,0,0.7)` -`HSL(540,70%,50%)` -`HSLA(540,70%,50%,0.7)` +![alt color-inline-colorchip-render-gfm](img/color_inline_colorchip_render_gfm.png) #### Supported formats: @@ -492,13 +474,7 @@ Example: Becomes: -```mermaid -graph TD; - A-->B; - A-->C; - B-->D; - C-->D; -``` + For details see the [Mermaid official page][mermaid]. -- cgit v1.2.1