diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2024-01-15 18:08:13 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2024-01-15 18:08:13 +0300 |
commit | a29eae68f453c371271641899e00ea24339fb1c6 (patch) | |
tree | 5c7d43159cdaee44d3f510db0f42941ed3f3bb90 /doc/user | |
parent | f58a5001b9c4988d8b95178b028a3d82bb346e28 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user')
-rw-r--r-- | doc/user/markdown.md | 189 | ||||
-rw-r--r-- | doc/user/packages/package_registry/dependency_proxy/index.md | 7 |
2 files changed, 98 insertions, 98 deletions
diff --git a/doc/user/markdown.md b/doc/user/markdown.md index 3ec8ba74c75..372442bb53f 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -32,9 +32,6 @@ As this Markdown specification is **valid for GitLab only**, you should We do our best to render the Markdown faithfully here, however the [GitLab documentation website](https://docs.gitlab.com) and the [GitLab handbook](https://handbook.gitlab.com) use a different Markdown processor. -GitLab Flavored Markdown extends the [CommonMark specification](https://spec.commonmark.org/current/). -It was inspired by [GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax). - ## Where you can use GitLab Flavored Markdown You can use GitLab Flavored Markdown in the following areas: @@ -53,32 +50,46 @@ to do so. For more information, see the [`gitlab-markup` gem project](https://gi ### Differences between GitLab Flavored Markdown and standard Markdown -GitLab uses standard CommonMark formatting. However, GitLab Flavored Markdown -extends standard Markdown with features made specifically for GitLab. +<!-- +Use this topic to list features that are not present in standard Markdown. +Don't repeat this information in each individual topic, unless there's a specific +reason, like in "Newlines". +--> + +GitLab Flavored Markdown consists of the following: + +- Core Markdown features, based on the [CommonMark specification](https://spec.commonmark.org/current/). +- Extensions from [GitHub Flavored Markdown](https://github.github.com/gfm/). +- Extensions made specifically for GitLab. + +All standard Markdown formatting should work as expected in GitLab. Some standard +functionality is extended with additional features, without affecting the standard usage. The following features are not found in standard Markdown: - [Color chips written in `HEX`, `RGB` or `HSL`](#colors) - [Diagrams and flowcharts](#diagrams-and-flowcharts) - [Emoji](#emoji) +- [Footnotes](#footnotes) - [Front matter](#front-matter) +- [GitLab-specific references](#gitlab-specific-references) - [Inline diffs](#inline-diff) - [Math equations and symbols written in LaTeX](#math) -- [Task Lists](#task-lists) +- [Strikethrough](#emphasis) - [Table of Contents](#table-of-contents) -- [Wiki specific Markdown](#wiki-specific-markdown) +- [Tables](#tables) +- [Task lists](#task-lists) +- [Wiki-specific Markdown](#wiki-specific-markdown) -The following features be are extended from standard Markdown: +The following features are extended from standard Markdown: | Standard Markdown | Extended Markdown in GitLab | |---------------------------------------|---------------------------------------------------------------------------------------| -| [blockquotes](#blockquotes) | [multi-line blockquotes](#multiline-blockquote) | -| [code blocks](#code-spans-and-blocks) | [colored code and syntax highlighting](#colored-code-and-syntax-highlighting) | -| [emphasis](#emphasis) | [multiple underscores in words](#multiple-underscores-in-words-and-mid-word-emphasis) | -| [headings](#headings) | [linkable heading IDs](#heading-ids-and-links) | -| [images](#images) | [embedded videos](#videos) and [audio](#audio) | -| [line breaks](#line-breaks) | [more line break control](#newlines) | -| [links](#links) | [automatically linking URLs](#url-auto-linking) | +| [Blockquotes](#blockquotes) | [Multiline blockquotes](#multiline-blockquote) | +| [Code blocks](#code-spans-and-blocks) | [Colored code and syntax highlighting](#colored-code-and-syntax-highlighting) | +| [Headings](#headings) | [Linkable heading IDs](#heading-ids-and-links) | +| [Images](#images) | [Embedded videos](#videos) and [audio](#audio) | +| [Links](#links) | [Automatically linking URLs](#url-auto-linking) | ## Markdown and accessibility @@ -103,11 +114,7 @@ If there is no otherwise meaningful value for a cell, consider entering **N/A** Describe the image or video in the `[alt text]`. Make the description accurate, succinct, and unique. Don't use `image of` or `video of` in the description. For more information, see [WebAim Alternative Text](https://webaim.org/techniques/alttext/). -## Features not found in standard Markdown - -The following features are not found in standard Markdown. - -### Colors +## Colors [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#colors). @@ -146,7 +153,7 @@ display a color chip next to the color code. For example: - `HSL(540,70%,50%)` - `HSLA(540,70%,50%,0.3)` -### Diagrams and flowcharts +## Diagrams and flowcharts You can generate diagrams from text by using: @@ -156,7 +163,7 @@ You can generate diagrams from text by using: In wikis, you can also add and edit diagrams created with the [diagrams.net editor](#diagramsnet-editor). -#### Mermaid +### Mermaid [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#mermaid). @@ -223,17 +230,17 @@ graph TB end ``` -#### PlantUML +### PlantUML PlantUML integration is enabled on GitLab.com. To make PlantUML available in self-managed installation of GitLab, a GitLab administrator [must enable it](../administration/integration/plantuml.md). -#### Kroki +### Kroki To make Kroki available in GitLab, a GitLab administrator must enable it. For more information, see the [Kroki integration](../administration/integration/kroki.md) page. -### Emoji +## Emoji [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#emoji). @@ -266,7 +273,7 @@ Consult the [Emoji Cheat Sheet](https://www.webfx.com/tools/emoji-cheat-sheet/) for a list of all supported emoji codes. :thumbsup: ``` -#### Emoji and your operating system +### Emoji and your operating system The previous emoji example uses hard-coded images. Rendered emoji in GitLab might look different depending on the OS and browser used. @@ -284,7 +291,7 @@ this font installed by default. To learn more about adding custom emoji, see [Custom emoji](emoji_reactions.md#custom-emoji). -### Front matter +## Front matter Front matter is metadata included at the beginning of a Markdown document, preceding the content. This data can be used by static site generators like [Jekyll](https://jekyllrb.com/docs/front-matter/), @@ -346,7 +353,7 @@ $example = array( --- ``` -### Inline diff +## Inline diff [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#inline-diff). @@ -385,7 +392,7 @@ each backtick with a backslash <code>\</code>: ![Inline diff with mixed formatting, as rendered by the GitLab interface](img/inline_diff_02_v13_3.png) -### Math +## Math > - LaTeX-compatible fencing [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21757) in GitLab 15.4 [with a flag](../administration/feature_flags.md) named `markdown_dollar_math`. Disabled by default. Enabled on GitLab.com. > - LaTeX-compatible fencing [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/371180) in GitLab 15.8. Feature flag `markdown_dollar_math` removed. @@ -442,7 +449,7 @@ $$ a^2+b^2=c^2 $$ -### Task lists +## Task lists > Inapplicable checkboxes [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/85982) in GitLab 15.3. @@ -479,7 +486,7 @@ To create a task list, follow the format of an ordered or unordered list: To include task lists in tables, [use HTML list tags or HTML tables](#task-lists-in-tables). -### Table of contents +## Table of contents A table of contents is an unordered list that links to subheadings in the document. You can add a table of contents to issues, merge requests, and epics, but you can't add one @@ -528,13 +535,13 @@ Second section content. ![Preview of an auto-generated table of contents in a Wiki](img/markdown_toc_preview_v12_9.png) -### Wiki-specific Markdown +## Wiki-specific Markdown The following topics show how links inside wikis behave. When linking to wiki pages, you should use the **page slug** rather than the page name. -#### Wiki - direct page link +### Wiki - direct page link A direct page link includes the slug for a page that points to that page, at the base level of the wiki. @@ -545,7 +552,7 @@ This example links to a `documentation` page at the root of your wiki: [Link to Documentation](documentation) ``` -#### Wiki - direct file link +### Wiki - direct file link A direct file link points to a file extension for a file, relative to the current page. @@ -556,7 +563,7 @@ it links to `<your_wiki>/documentation/file.md`: [Link to File](file.md) ``` -#### Wiki - hierarchical link +### Wiki - hierarchical link A hierarchical link can be constructed relative to the current wiki page by using `./<page>`, `../<page>`, and so on. @@ -589,7 +596,7 @@ it links to `<your_wiki>/documentation/main.md`: [Link to Related Page](../main.md) ``` -#### Wiki - root link +### Wiki - root link A root link starts with a `/` and is relative to the wiki root. @@ -605,7 +612,7 @@ This example links to `<wiki_root>/miscellaneous.md`: [Link to Related Page](/miscellaneous.md) ``` -#### diagrams.net editor +### diagrams.net editor > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/322174) in GitLab 15.10. @@ -615,7 +622,7 @@ the plain text editor and the rich text editor. For more information, see [Diagrams.net](../administration/integration/diagrams_net.md). -##### Plain text editor +#### Plain text editor To create a diagram in the plain text editor: @@ -641,7 +648,7 @@ To edit a diagram in the plain text editor: A Markdown image reference to the diagram is inserted in the wiki content, replacing the previous diagram. -##### Rich text editor +#### Rich text editor To create a diagram in the rich text editor: @@ -723,9 +730,11 @@ For example: > - Support for issues, merge requests, and epics [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15694) in GitLab 14.6. > - Support for work items [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390854) in GitLab 16.0. -To include the title in the rendered link of an issue, work item, merge request, or epic, add a plus (`+`) -at the end of the reference. For example, a reference like `#123+` is rendered as -`The issue title (#123)`. +To include the title in the rendered link of an issue, work item, merge request, or epic: + +- Add a plus (`+`) at the end of the reference. + +For example, a reference like `#123+` is rendered as `The issue title (#123)`. URL references like `https://gitlab.com/gitlab-org/gitlab/-/issues/1234+` are also expanded. @@ -761,13 +770,7 @@ To embed an Observability dashboard URL: 1. In GitLab Observability UI, copy the URL in the address bar. 1. Paste your link in a comment or description. GitLab Flavored Markdown recognizes the URL and displays the source. -## Features extended from standard Markdown - -All standard Markdown formatting should work as expected in GitLab. Some standard -functionality is extended with additional features, without affecting the standard usage. -If a functionality is extended, the new option is listed as a sub-section. - -### Blockquotes +## Blockquotes [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#blockquotes). @@ -790,12 +793,11 @@ Quote break. > This very long line is still quoted properly when it wraps. Keep writing to make sure this line is long enough to actually wrap for everyone. You can also *use* **Markdown** in a blockquote. -#### Multiline blockquote +### Multiline blockquote [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#multiline-blockquote). -GitLab Flavored Markdown extends the standard Markdown by also supporting multi-line blockquotes -fenced by `>>>`, with a blank line before and after the block: +Create multi-line blockquotes fenced by `>>>`, with a blank line before and after the block: ```markdown @@ -821,13 +823,13 @@ trigger this problem. > > you can quote that without having to manually prepend `>` to every line! -### Code spans and blocks +## Code spans and blocks [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#code-spans-and-blocks). -You can highlight anything that should be viewed as code and not standard text. +Highlight anything that should be viewed as code and not standard text. -Inline code is highlighted with single backticks `` ` ``: +Inline code is formatted with single backticks `` ` ``: ```markdown Inline `code` has `back-ticks around` it. @@ -884,7 +886,7 @@ is like using Tildes are OK too. ``` -#### Colored code and syntax highlighting +### Colored code and syntax highlighting [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#colored-code-and-syntax-highlighting). @@ -948,13 +950,12 @@ s = "No highlighting is shown for this line." But let's throw in a <b>tag</b>. ``` -### Emphasis +## Emphasis [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#emphasis). -In Markdown, you can emphasize text in multiple ways. You can italicize, bold, strikethrough, -and combine these emphasis styles together. -Strikethrough is not part of the core Markdown standard, but is part of GitLab Flavored Markdown. +You can emphasize text in multiple ways. Use italics, bold, strikethrough, +or combine these emphasis styles together. Examples: @@ -980,13 +981,14 @@ Strikethrough with double tildes. ~~Scratch this.~~ <!-- markdownlint-enable MD050 --> -#### Multiple underscores in words and mid-word emphasis +### Multiple underscores in words and mid-word emphasis [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#multiple-underscores-in-words). Avoid italicizing a portion of a word, especially when you're dealing with code and names that often appear with multiple underscores. -GitLab Flavored Markdown extends the standard Markdown standard by ignoring multiple underlines in words, + +GitLab Flavored Markdown ignores multiple underlines in words, to allow better rendering of Markdown documents discussing code: ```markdown @@ -1021,7 +1023,7 @@ perform*complicated*task do*this*and*do*that*and*another thing -### Footnotes +## Footnotes [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#footnotes). @@ -1060,7 +1062,9 @@ These are used to force the Vale ReferenceLinks check to skip these examples. [^footnote-42]: This text is another footnote. -### Headings +## Headings + +Create headings from 1 to 6 by using `#`. ```markdown # H1 @@ -1071,7 +1075,7 @@ These are used to force the Vale ReferenceLinks check to skip these examples. ###### H6 ``` -Alternatively, for H1 and H2, an underline style: +Alternatively, for H1 and H2, use an underline style: ```markdown Alt-H1 @@ -1081,12 +1085,12 @@ Alt-H2 ------ ``` -#### Heading IDs and links +### Heading IDs and links [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#heading-ids-and-links). -GitLab Flavored Markdown extends the standard Markdown standard so that all Markdown-rendered headings automatically -get IDs, which can be linked to, except in comments. +All Markdown-rendered headings automatically +get IDs that can be linked to, except in comments. On hover, a link to those IDs becomes visible to make it easier to copy the link to the heading to use it somewhere else. @@ -1123,7 +1127,7 @@ Would generate the following link IDs: Emoji processing happens before the heading IDs are generated. The emoji is converted to an image, which is then removed from the ID. -### Horizontal Rule +## Horizontal rule [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#horizontal-rule). @@ -1143,7 +1147,7 @@ ___ --- -### Images +## Images Embed images using inline or reference links. To see title text, hover over the image. @@ -1189,7 +1193,7 @@ Reference-style: <!-- markdownlint-enable proper-names --> -#### Change the image or video dimensions +### Change the image or video dimensions > - Support for images [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/28118) in GitLab 15.7. > - Support for videos [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17139) in GitLab 15.9. @@ -1213,7 +1217,7 @@ For example You can also use the `img` HTML tag instead of Markdown and set its `height` and `width` parameters. -#### Videos +### Videos [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#videos). @@ -1228,7 +1232,7 @@ Here's an example video: ![Sample Video](img/markdown_video.mp4) -#### Audio +### Audio [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#audio). @@ -1243,7 +1247,7 @@ Here's an example audio clip: ![Sample Audio](img/markdown_audio.mp3) -### Inline HTML +## Inline HTML > Allowing `rel="license"` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/20857) in GitLab 14.6. @@ -1310,7 +1314,7 @@ Markdown is fine in GitLab. </dd> </dl> -#### Collapsible section +### Collapsible section [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#details-and-summary). @@ -1375,7 +1379,7 @@ These details <em>remain</em> <b>hidden</b> until expanded. </details> -### Line breaks +## Line breaks [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#line-breaks). @@ -1405,7 +1409,7 @@ These lines are only separated by single newlines, so they *do not break* and just follow the previous lines in the *same paragraph*. -#### Newlines +### Newlines GitLab Flavored Markdown adheres to the Markdown specification for handling [paragraphs and line breaks](https://spec.commonmark.org/current/). @@ -1428,7 +1432,7 @@ Another line, this time ending with a backslash.\ A new line due to the previous backslash. ``` -### Links +## Links [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#links). @@ -1491,11 +1495,11 @@ page, or a wiki page in a project file. The reason: a wiki is always in a separate Git repository in GitLab. For example, `[I'm a reference-style link](style)` points the link to `wikis/style` only when the link is inside of a wiki Markdown file. -#### URL auto-linking +### URL auto-linking [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#url-auto-linking). -GitLab Flavored Markdown auto-links almost any URL you put into your text: +Almost any URL you put into your text is auto-linked: ```markdown - https://www.google.com @@ -1517,7 +1521,7 @@ GitLab Flavored Markdown auto-links almost any URL you put into your text: <!-- vale gitlab.Spelling = YES --> -### Lists +## Lists [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#lists). @@ -1674,12 +1678,11 @@ For example: CommonMark ignores the blank line and renders this as one list with paragraph spacing. -### Superscripts / Subscripts +## Superscripts / Subscripts [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#superscripts-subscripts). -CommonMark and GitLab Flavored Markdown don't support the Redcarpet superscript syntax ( `x^2` ). -Use the standard HTML syntax for superscripts and subscripts: +For superscripts and subscripts, use the standard HTML syntax: ```html The formula for water is H<sub>2</sub>O @@ -1693,7 +1696,9 @@ while the equation for the theory of relativity is E = mc<sup>2</sup>. <!-- vale gitlab.Spelling = YES --> -### Keyboard HTML tag +GitLab Flavored Markdown doesn't support the Redcarpet superscript syntax ( `x^2` ). + +## Keyboard HTML tag [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#keyboard-html-tag). @@ -1705,11 +1710,11 @@ Press <kbd>Enter</kbd> to go to the next page. Press <kbd>Enter</kbd> to go to the next page. -### Tables +## Tables [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#tables-1). -Tables are not part of the core Markdown specification, but are part of GitLab Flavored Markdown. +When creating tables: - The first line contains the headers, separated by "pipes" (`|`). - The second line separates the headers from the cells. @@ -1743,7 +1748,7 @@ Example: | cell 4 | cell 5 is longer | cell 6 is much longer than the others, but that's ok. It eventually wraps the text when the cell is too large for the display size. | | cell 7 | | cell 9 | -#### Alignment +### Alignment [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#alignment). @@ -1765,7 +1770,7 @@ to the sides of the "dash" lines in the second row. This affects every cell in t [In GitLab itself](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#tables), the headers are always left-aligned in Chrome and Firefox, and centered in Safari. -#### Cells with multiple lines +### Cells with multiple lines [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#cells-with-multiple-lines). @@ -1784,7 +1789,7 @@ use `<br>` tags to force a cell to have multiple lines: | Item1 | This text is on one line | | Item2 | This item has:<br>- Multiple items<br>- That we want listed separately | -#### Task lists in tables +### Task lists in tables To add [task lists](#task-lists) with checkboxes, use HTML formatting. Using either: @@ -1826,7 +1831,7 @@ To add [task lists](#task-lists) with checkboxes, use HTML formatting. Using eit You can also [create a table in the rich text editor](rich_text_editor.md#tables) and insert a task list then. -#### Copy and paste from a spreadsheet +### Copy and paste from a spreadsheet If you're working in spreadsheet software (for example, Microsoft Excel, Google Sheets, or Apple Numbers), GitLab creates a Markdown table when you copy and paste @@ -1840,7 +1845,7 @@ entry and paste the spreadsheet: ![Paste to Markdown table](img/markdown_paste_table_v12_7.png) -#### JSON +### JSON > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86353) in GitLab 15.3. diff --git a/doc/user/packages/package_registry/dependency_proxy/index.md b/doc/user/packages/package_registry/dependency_proxy/index.md index 7b5e7a4c624..88e424ed3ac 100644 --- a/doc/user/packages/package_registry/dependency_proxy/index.md +++ b/doc/user/packages/package_registry/dependency_proxy/index.md @@ -7,12 +7,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Dependency proxy for packages **(PREMIUM ALL BETA)** > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3610) in GitLab 16.6 [with a flag](../../../../administration/feature_flags.md) named `packages_dependency_proxy_maven`. Disabled by default. -> - This feature is in [Beta](../../../../policy/experiment-beta-support.md). - -FLAG: -On self-managed GitLab, by default this feature is not available. To make it available, an administrator can [enable the feature flag](../../../../administration/feature_flags.md) named `packages_dependency_proxy_maven`. -On GitLab.com, this feature is not available. -The feature is not ready for production use. +> - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/415218) in GitLab 16.8. Feature flag `packages_dependency_proxy_maven` removed. The GitLab dependency proxy for packages is a local proxy for frequently pulled packages. It is implemented as a pull-through cache that works at the project level. |