diff options
Diffstat (limited to 'doc/user')
-rw-r--r-- | doc/user/asciidoc.md | 2 | ||||
-rw-r--r-- | doc/user/markdown.md | 76 | ||||
-rw-r--r-- | doc/user/project/import/gemnasium.md | 4 | ||||
-rw-r--r-- | doc/user/project/integrations/github.md | 2 |
4 files changed, 42 insertions, 42 deletions
diff --git a/doc/user/asciidoc.md b/doc/user/asciidoc.md index a22b285b114..0ed9bf3f518 100644 --- a/doc/user/asciidoc.md +++ b/doc/user/asciidoc.md @@ -6,7 +6,7 @@ Consult the [Asciidoctor User Manual](https://asciidoctor.org/docs/user-manual) ## Syntax Here's a brief reference of the most commonly used AsciiDoc syntax. -You can find the full documentation for the AsciiDoc syntax at https://asciidoctor.org/docs. +You can find the full documentation for the AsciiDoc syntax at <https://asciidoctor.org/docs>. ### Paragraphs diff --git a/doc/user/markdown.md b/doc/user/markdown.md index f8eea618c84..a08b41aaecb 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -119,7 +119,7 @@ changing how standard markdown is used: | [links](#links) | [automatically linking URLs](#url-auto-linking) | ## New GFM markdown extensions - + ### Colors > If this is not rendered correctly, [view it in GitLab itself](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/user/markdown.md#colors). @@ -136,26 +136,26 @@ Supported formats (named colors are not supported): Color written inside backticks will be followed by a color "chip": ```markdown -`#F00` -`#F00A` -`#FF0000` -`#FF0000AA` -`RGB(0,255,0)` -`RGB(0%,100%,0%)` -`RGBA(0,255,0,0.3)` -`HSL(540,70%,50%)` -`HSLA(540,70%,50%,0.3)` -``` - -`#F00` -`#F00A` -`#FF0000` -`#FF0000AA` -`RGB(0,255,0)` -`RGB(0%,100%,0%)` -`RGBA(0,255,0,0.3)` -`HSL(540,70%,50%)` -`HSLA(540,70%,50%,0.3)` +`#F00` +`#F00A` +`#FF0000` +`#FF0000AA` +`RGB(0,255,0)` +`RGB(0%,100%,0%)` +`RGBA(0,255,0,0.3)` +`HSL(540,70%,50%)` +`HSLA(540,70%,50%,0.3)` +``` + +`#F00` +`#F00A` +`#FF0000` +`#FF0000AA` +`RGB(0,255,0)` +`RGB(0%,100%,0%)` +`RGBA(0,255,0,0.3)` +`HSL(540,70%,50%)` +`HSLA(540,70%,50%,0.3)` ### Diagrams and flowcharts using Mermaid @@ -359,7 +359,7 @@ version to reference other projects from the same namespace. GFM will recognize the following: -| references | input | cross-project reference | shortcut within same namespace | +| references | input | cross-project reference | shortcut within same namespace | | :------------------------------ | :------------------------- | :-------------------------------------- | :----------------------------- | | specific user | `@user_name` | | | | specific group | `@group_name` | | | @@ -704,7 +704,7 @@ but_emphasis is_desired _here_ ``` perform_complicated_task - + do_this_and_do_that_and_another_thing but_emphasis is_desired _here_ @@ -715,12 +715,12 @@ If you wish to emphasize only a part of a word, it can still be done with asteri ```md perform*complicated*task - + do*this*and*do*that*and*another thing ``` perform*complicated*task - + do*this*and*do*that*and*another thing ### Footnotes @@ -910,9 +910,9 @@ are separated into their own lines: <dt>Markdown in HTML</dt> <dd> - + Does *not* work **very** well. HTML tags will always work. - + </dd> </dl> ``` @@ -925,9 +925,9 @@ are separated into their own lines: <dt>Markdown in HTML</dt> <dd> - + Does <em>not</em> work <b>very</b> well. HTML tags will always work. - + </dd> </dl> @@ -1045,14 +1045,14 @@ A new line due to the previous backslash. First paragraph. Another line in the same paragraph. -A third line in the same paragraph, but this time ending with two spaces. +A third line in the same paragraph, but this time ending with two spaces. A new line directly under the first paragraph. <!-- (Do *NOT* remove the two ending whitespaces in the second line) --> <!-- (They are needed for the Markdown text to render correctly on docs.gitlab.com, the backslash works fine inside GitLab itself) --> Second paragraph. -Another line, this time ending with a backslash. +Another line, this time ending with a backslash. A new line due to the previous backslash. ### Links @@ -1123,12 +1123,12 @@ GFM will autolink almost any URL you put into your text: - http://localhost:3000 ``` -- https://www.google.com -- https://google.com/ -- ftp://ftp.us.debian.org/debian/ -- smb://foo/bar/baz -- irc://irc.freenode.net/gitlab -- http://localhost:3000 +- <https://www.google.com> +- <https://google.com/> +- <ftp://ftp.us.debian.org/debian/> +- <smb://foo/bar/baz> +- <irc://irc.freenode.net/gitlab> +- <http://localhost:3000> ### Lists @@ -1229,7 +1229,7 @@ while the equation for the theory of relativity is E = mc<sup>2</sup>. Tables aren't part of the core Markdown spec, but they are part of GFM. -1. The first line contains the headers, separated by "pipes" (`|`). +1. The first line contains the headers, separated by "pipes" (`|`). 1. The second line separates the headers from the cells, and must contain three or more dashes. 1. The third, and any following lines, contain the cell values. - You **can't** have cells separated over many lines in the markdown, they must be kept to single lines, diff --git a/doc/user/project/import/gemnasium.md b/doc/user/project/import/gemnasium.md index 7f79ebf6353..3b071ff590f 100644 --- a/doc/user/project/import/gemnasium.md +++ b/doc/user/project/import/gemnasium.md @@ -40,14 +40,14 @@ some steps to migrate your projects. There is no automatic import since GitLab doesn't know anything about any projects which existed on Gemnasium.com. Security features are free for public (open-source) projects hosted on GitLab.com. -### If your project is hosted on GitLab (https://gitlab.com / self-hosted) +### If your project is hosted on GitLab (`https://gitlab.com` / self-hosted) You're almost set! If you're already using [Auto DevOps](../../../topics/autodevops/), you are already covered. Otherwise, you must configure your `.gitlab-ci.yml` according to the [dependency scanning page](../../application_security/dependency_scanning/index.md). -### If your project is hosted on GitHub (https://github.com / GitHub Enterprise) +### If your project is hosted on GitHub (`https://github.com` / GitHub Enterprise) Since [GitLab 10.6 comes with GitHub integration](https://about.gitlab.com/features/github/), GitLab users can now create a CI/CD project in GitLab connected to an external diff --git a/doc/user/project/integrations/github.md b/doc/user/project/integrations/github.md index cdb0e34fdf6..680fcdb78bb 100644 --- a/doc/user/project/integrations/github.md +++ b/doc/user/project/integrations/github.md @@ -17,7 +17,7 @@ and is automatically configured on [GitHub import](../../../integration/github.m This integration requires a [GitHub API token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) with `repo:status` access granted: -1. Go to your "Personal access tokens" page at https://github.com/settings/tokens +1. Go to your "Personal access tokens" page at <https://github.com/settings/tokens> 1. Click "Generate New Token" 1. Ensure that `repo:status` is checked and click "Generate token" 1. Copy the generated token to use on GitLab |