as its markdown rendering engine. See the [GitLab Markdown Guide](https://about.gitlab.com/handbook/product/technical-writing/markdown-guide/) for a complete Kramdown reference.
as its Markdown rendering engine. See the [GitLab Markdown Guide](https://about.gitlab.com/handbook/product/technical-writing/markdown-guide/) for a complete Kramdown reference.
Adhere to the [Documentation Style Guide](styleguide.md). If a style standard is missing, you are welcome to suggest one via a merge request.
Adhere to the [Documentation Style Guide](styleguide.md). If a style standard is missing, you are welcome to suggest one via a merge request.
...
@@ -449,7 +449,7 @@ A file with `proselint` configuration must be placed in a
...
@@ -449,7 +449,7 @@ A file with `proselint` configuration must be placed in a
#### `markdownlint`
#### `markdownlint`
[`markdownlint`](https://github.com/DavidAnson/markdownlint) checks that markdown
[`markdownlint`](https://github.com/DavidAnson/markdownlint) checks that Markdown
@@ -490,7 +490,7 @@ For other punctuation rules, please refer to the
...
@@ -490,7 +490,7 @@ For other punctuation rules, please refer to the
## Links
## Links
- Use inline link markdown markup `[Text](https://example.com)`.
- Use inline link Markdown markup `[Text](https://example.com)`.
It's easier to read, review, and maintain. **Do not** use `[Text][identifier]`.
It's easier to read, review, and maintain. **Do not** use `[Text][identifier]`.
- Use [meaningful anchor texts](https://www.futurehosting.com/blog/links-should-have-meaningful-anchor-text-heres-why/).
- Use [meaningful anchor texts](https://www.futurehosting.com/blog/links-should-have-meaningful-anchor-text-heres-why/).
...
@@ -533,7 +533,7 @@ For other punctuation rules, please refer to the
...
@@ -533,7 +533,7 @@ For other punctuation rules, please refer to the
[issue tags](../../issues/tags.md#stages)
[issue tags](../../issues/tags.md#stages)
```
```
- Using the markdown extension is necessary for the [`/help`](index.md#gitlab-help)
- Using the Markdown extension is necessary for the [`/help`](index.md#gitlab-help)
section of GitLab.
section of GitLab.
### Links requiring permissions
### Links requiring permissions
...
@@ -656,7 +656,7 @@ to readers.
...
@@ -656,7 +656,7 @@ to readers.
To embed a video, follow the instructions below and make sure
To embed a video, follow the instructions below and make sure
you have your MR reviewed and approved by a technical writer.
you have your MR reviewed and approved by a technical writer.
1. Copy the code below and paste it into your markdown file.
1. Copy the code below and paste it into your Markdown file.
Leave a blank line above and below it. Do NOT edit the code
Leave a blank line above and below it. Do NOT edit the code
(don't remove or add any spaces, etc).
(don't remove or add any spaces, etc).
1. On YouTube, visit the video URL you want to display. Copy
1. On YouTube, visit the video URL you want to display. Copy
...
@@ -694,7 +694,7 @@ This is how it renders on the GitLab Docs site:
...
@@ -694,7 +694,7 @@ This is how it renders on the GitLab Docs site:
class is necessary to make sure the video is responsive and displays
class is necessary to make sure the video is responsive and displays
nicely on different mobile devices.
nicely on different mobile devices.
> - The `<div class="video-fallback">` is a fallback necessary for GitLab's
> - The `<div class="video-fallback">` is a fallback necessary for GitLab's
`/help`, as GitLab's markdown processor does not support iframes. It's hidden on the docs site but will be displayed on GitLab's `/help`.
`/help`, as GitLab's Markdown processor does not support iframes. It's hidden on the docs site but will be displayed on GitLab's `/help`.
## Code blocks
## Code blocks
...
@@ -725,7 +725,7 @@ nicely on different mobile devices.
...
@@ -725,7 +725,7 @@ nicely on different mobile devices.
```
```
~~~
~~~
- To display raw markdown instead of rendered markdown, you can use triple backticks
- To display raw Markdown instead of rendered Markdown, you can use triple backticks
with `md`, like the `Markdown code` example above, unless you want to include triple
with `md`, like the `Markdown code` example above, unless you want to include triple
backticks in the code block as well. In that case, use triple tildes (`~~~`) instead.
backticks in the code block as well. In that case, use triple tildes (`~~~`) instead.
- For a complete reference on code blocks, check the [Kramdown guide](https://about.gitlab.com/handbook/product/technical-writing/markdown-guide/#code-blocks).
- For a complete reference on code blocks, check the [Kramdown guide](https://about.gitlab.com/handbook/product/technical-writing/markdown-guide/#code-blocks).
...
@@ -739,7 +739,7 @@ _Note that the alert boxes only work for one paragraph only. Multiple paragraphs
...
@@ -739,7 +739,7 @@ _Note that the alert boxes only work for one paragraph only. Multiple paragraphs
lists, headers, etc will not render correctly. For multiple lines, use blockquotes instead._
lists, headers, etc will not render correctly. For multiple lines, use blockquotes instead._
Alert boxes only render on the GitLab Docs site (<https://docs.gitlab.com>).
Alert boxes only render on the GitLab Docs site (<https://docs.gitlab.com>).
Within GitLab itself, they will appear as plain markdown text (like the examples
Within GitLab itself, they will appear as plain Markdown text (like the examples
GitLab will sign the request with the provided private key. GitLab will include the configured public x500 certificate in the metadata for your Identity Provider to validate the signature of the received request with. For more information on this option, see the [ruby-saml gem documentation](https://github.com/onelogin/ruby-saml/tree/v1.7.0). The `ruby-saml` gem is used by the [omniauth-saml gem](https://github.com/omniauth/omniauth-saml) to implement the client side of the SAML authentication.
GitLab will sign the request with the provided private key. GitLab will include the configured public x500 certificate in the metadata for your Identity Provider to validate the signature of the received request with. For more information on this option, see the [Ruby SAML gem documentation](https://github.com/onelogin/ruby-saml/tree/v1.7.0). The Ruby SAML gem is used by the [OmniAuth SAML gem](https://github.com/omniauth/omniauth-saml) to implement the client side of the SAML authentication.