stage | group | info |
---|---|---|
none |
unassigned |
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments |
DETAILS: Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated
You can update your preferences to change the look and feel of GitLab.
You can change the color theme of the GitLab UI. These colors are displayed on the left sidebar. Using individual color themes might help you differentiate between your different GitLab instances.
To change the color theme:
- On the left sidebar, select your avatar.
- Select Preferences.
- In the Color theme section, select a theme.
- Introduced in GitLab 13.1 as an experiment.
Dark mode makes elements on the GitLab UI stand out on a dark background.
- To turn on Dark mode, Select Preferences > Color theme > Dark Mode.
Dark mode works only with the Dark Syntax highlighting theme. You can report and view issues, send feedback, and track progress in epic 2092.
- Changing the default syntax highlighting theme for authenticated and unauthenticated users Introduced in GitLab 15.1.
Syntax highlighting is a feature in code editors and IDEs. The highlighter assigns a color to each type of code, such as strings and comments.
To change the syntax highlighting theme:
- On the left sidebar, select your avatar.
- Select Preferences.
- In the Syntax highlighting theme section, select a theme.
- Select Save changes.
To view the updated syntax highlighting theme, refresh your project's page.
To customize the syntax highlighting theme, you can also use the Application settings API. Use default_syntax_highlighting_theme
to change the syntax highlighting colors on a more granular level.
If these steps do not work, your programming language might not be supported by the syntax highlighters. For more information, view Rouge Ruby Library for guidance on code files and Snippets. View Monaco Editor and Monarch for guidance on the Web IDE.
Diffs use two different background colors to show changes between versions of code. By default, the original file is in red, and the changes are in green.
To change the diff colors:
- On the left sidebar, select your avatar.
- Select Preferences.
- Go to the Diff colors section.
- Select a color or enter a color code.
- Select Save changes.
To change back to the default colors, clear the Color for removed lines and Color for added lines text boxes and select Save changes.
Use the Behavior section to customize the behavior and layout of your GitLab self-managed instance. You can change your layout width and choose the default content for your homepage, group and project overview pages. You have options to customize appearance and function, like whitespace rendering, file display, and text automation.
You can stretch content on the GitLab UI to fill the entire page. By default, page content is fixed at 1280 pixels wide.
To change the layout width of your UI:
- On the left sidebar, select your avatar.
- Select Preferences.
- Scroll to the Behavior section.
- Under Layout width, choose Fixed or Fluid.
- Select Save changes.
- Introduced in GitLab 16.6 with a flag named
ui_for_organizations
. Disabled by default.
FLAG:
On self-managed GitLab, by default this feature is not available. To make it available, an administrator can enable the feature flag named ui_for_organizations
.
On GitLab.com and GitLab Dedicated, this feature is not available.
This feature is not ready for production use.
If you are a member of two or more organizations, you can choose a home organization. This is the organization you are in by default when you first sign in to GitLab.
To choose your home organization:
- On the left sidebar, select your avatar.
- Select Preferences.
- Scroll to the Behavior section.
- From the Home organization dropdown list, select an option.
- Select Save changes.
Control what page you view when you select the GitLab logo ({tanuki}). You can set your homepage to be Projects (default), Your Groups, Your Activity, and other content.
- On the left sidebar, select your avatar.
- Select Preferences.
- Scroll to the Behavior section.
- From the Homepage dropdown list, select an option.
- Select Save changes.
You can change the main content on your group overview page. Your group overview page is the page that shows when you select Groups on the left sidebar. You can customize the default content for your group overview page to the:
- Details Dashboard (default), which includes an overview of group activities and projects.
- Security Dashboard, which might include group security policies and other security topics.
For more information, view Groups.
To change the default content on your group overview page:
- On the left sidebar, select your avatar.
- Select Preferences.
- Scroll to the Behavior section.
- From the Group overview content dropdown list, select an option.
- Select Save changes.
Your project overview page is the page you view when you select Project overview on the left sidebar. You can set your main project overview page to the Activity page, the README file, and other content.
- On the left sidebar, select your avatar.
- Select Preferences.
- Scroll to the Behavior section.
- From the Project overview content dropdown list, select an option.
- Select Save changes.
Shortcut buttons precede the list of files on a project's overview page. These buttons provide links to parts of a project, such as the README file or license agreements.
To hide shortcut buttons on the project overview page:
- On the left sidebar, select your avatar.
- Select Preferences.
- Scroll to the Behavior section.
- Clear the Show shortcut buttons above files on project overview checkbox.
- Select Save changes.
Whitespace characters are any blank characters in a text, such as spaces and indentations. You might use whitespace to structure content in code. If your programming language is sensitive to whitespaces, the Web IDE can detect changes to them.
To render whitespace in the Web IDE:
- On the left sidebar, select your avatar.
- Select Preferences.
- Scroll to the Behavior section.
- Select the Render whitespace characters in the Web IDE checkbox.
- Select Save changes.
You can view changes to whitespace in diffs.
To view diffs on the Web IDE, follow these steps:
- On the left sidebar, select Source Control ({branch}).
- Under the Changes tab, select your file.
View changes to whitespace in diff files. For more information on whitespaces, view the previous task.
To view changes to whitespace in diffs:
- On the left sidebar, select your avatar.
- Select Preferences.
- Scroll to the Behavior section.
- Select the Show whitespace changes in diffs checkbox.
- Select Save changes.
For more information on diffs, view Change the diff colors.
The Changes tab lets you view all file changes in a merge request on one page. Instead, you can choose to view one file at a time.
To show one file per page on the Changes tab:
- On the left sidebar, select your avatar.
- Select Preferences.
- Scroll to the Behavior section.
- Select the Show one file at a time on merge request's Changes tab checkbox.
- Select Save changes.
Then, to move between files on the Changes tab, below each file, select the Previous and Next buttons.
Automatically add the corresponding closing character to text when you type the opening character. For example, you can automatically insert a closing bracket when you type an opening bracket. This setting works only in description and comment boxes and for the following characters: **"
, '
, ```, (
, `[`, `{`, `<`, `*`, `_**`.
To auto-enclose characters in description and comment boxes:
- On the left sidebar, select your avatar.
- Select Preferences.
- Scroll to the Behavior section.
- Select the Surround text selection when typing quotes or brackets checkbox.
- Select Save changes.
In a description or comment box, you can now type a word, highlight it, then type an opening character. Instead of replacing the text, the closing character is added to the end.
Create a new list item when you press Enter in a list in description and comment boxes.
To add a new list item when you press the Enter key:
- On the left sidebar, select your avatar.
- Select Preferences.
- Scroll to the Behavior section.
- Select the Automatically add new list items checkbox.
- Select Save changes.
Change the default size of tabs in diffs, blobs, and snippets. The WebIDE, file editor, and Markdown editor do not support this feature.
To adjust the default tab width:
- On the left sidebar, select your avatar.
- Select Preferences.
- Scroll to the Behavior section.
- For Tab width, enter a value.
- Select Save changes.
Change localization settings such as your language, calendar start day, and time preferences.
GitLab supports multiple languages on the UI. To help improve translations or request support for an unlisted language, view Translating GitLab.
To choose a language for the GitLab UI:
- On the left sidebar, select your avatar.
- Select Preferences.
- Go to the Localization section.
- Under Language, select an option.
- Select Save changes.
You might need to refresh your page to view the updated language.
Choose which day of the week the contribution calendar starts with. The contribution calendar shows project contributions over the past year. You can view this calendar on each user profile. To access your user profile:
- On the left sidebar, select your avatar > select your name or username.
To change your contribution calendar start day:
- On the left sidebar, select your avatar.
- Select Preferences.
- Go to the Localization section.
- Under First day of the week, select an option.
- Select Save changes.
After you change your calendar start day, refresh your user profile page.
Customize the format used to display times of activities on your group and project overview pages and user profiles. You can display times in a:
- Relative format, for example
30 minutes ago
. - Absolute format, for example
September 3, 2022, 3:57 PM
.
To use exact times on the GitLab UI:
- On the left sidebar, select your avatar.
- Select Preferences.
- Go to the Time preferences section.
- Clear the Use relative times checkbox.
- Select Save changes.
- Introduced in GitLab 16.6.
You can customize the format used to display times of activities on your group and project overview pages and user profiles. You can display times as:
- 12 hour format. For example:
2:34 PM
. - 24 hour format. For example:
14:34
.
You can also follow your system's setting.
To customize the time format:
- On the left sidebar, select your avatar.
- Select Preferences.
- Go to the Time preferences section.
- Under Time format, select either the System, 12-hour, or 24-hour option.
- Select Save changes.
DETAILS: Tier: Premium, Ultimate Offering: GitLab.com, Self-managed Status: Beta
- Introduced as a beta in GitLab 15.9 with flags named
index_code_with_zoekt
andsearch_code_with_zoekt
. Disabled by default.- Enabled on GitLab.com in GitLab 16.6.
- Feature flags
index_code_with_zoekt
andsearch_code_with_zoekt
removed in GitLab 17.1.
WARNING: This feature is in beta and subject to change without notice. For more information, see epic 9404.
Prerequisites:
- For GitLab self-managed, an administrator must enable exact code search.
To disable exact code search in user preferences:
- On the left sidebar, select your avatar.
- Select Preferences.
- Go to the Exact code search section.
- Clear the Enable exact code search checkbox.
- Select Save changes.
- Introduced in GitLab 16.0.
CI/CD jobs generate JSON web tokens, which can include a list of your external identities. Instead of making separate API calls to get individual accounts, you can find your user identities in a single authentication token.
External identities are not included by default. To enable including external identities, see Token payload.
- Introduced in GitLab 16.0.
Turn off the ability to follow or be followed by other GitLab users. By default, your user profile, including your name and profile photo, is public in the Following tabs of other users. When you deactivate this setting:
- GitLab deletes all of your followers and followed connections.
- GitLab automatically removes your user profile from the pages of each connection.
To remove the ability to be followed by and follow other users:
- On the left sidebar, select your avatar.
- Select Preferences.
- Clear the Enable follow users checkbox.
- Select Save changes.
To access your Followers and Following tabs:
- On the left sidebar, select your avatar > select your name or username.
- Select Followers or Following.
Give third-party services access to enhance the GitLab experience.
Configure your GitLab instance with Gitpod when you want to launch and manage code directly from your GitLab browser. Gitpod automatically prepares and builds development environments for your projects.
To integrate with Gitpod:
- On the left sidebar, select your avatar.
- Select Preferences.
- Find the Integrations section.
- Select the Enable Gitpod integration checkbox.
- Select Save changes.
GitLab supports Sourcegraph integration for all public projects on GitLab.
To integrate with Sourcegraph:
- On the left sidebar, select your avatar.
- Select Preferences.
- Find the Integrations section.
- Select the Enable integrated code intelligence on code views checkbox.
- Select Save changes.
You must be the administrator of the GitLab instance to configure GitLab with Sourcegraph.
DETAILS: Offering: GitLab.com
- Introduced as a beta in GitLab 17.0 with flags named
web_ide_oauth
andweb_ide_extensions_marketplace
. Disabled by default.- Feature flag
web_ide_oauth
enabled on GitLab.com, self-managed, and GitLab Dedicated and feature flagweb_ide_extensions_marketplace
enabled on GitLab.com in GitLab 17.4.- Feature flag
web_ide_oauth
removed in GitLab 17.5.
FLAG: The availability of this feature is controlled by a feature flag. For more information, see the history.
You can use the extension marketplace to search and manage extensions for the Web IDE and workspaces. For third-party extensions, you must enable the marketplace in user preferences.
To enable the extension marketplace for the Web IDE and workspaces:
- On the left sidebar, select your avatar.
- Select Preferences.
- Go to the Integrations section.
- Select the Enable extension marketplace checkbox.
- In the third-party extension acknowledgement, select I understand.
- Select Save changes.