kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity
gitlab-org--gitlab-foss/doc/user/project/wiki/index.md

15 KiB
Raw Blame History

stage group info type
Create Editor To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments reference, how-to

Wiki (FREE)

If you don't want to keep your documentation in your repository, but you want to keep it in the same project as your code, you can use the wiki GitLab provides in each GitLab project. Every wiki is a separate Git repository, so you can create wiki pages in the web interface, or locally using Git.

To access the wiki for a project or group, go to the page for your project or group and, in the left sidebar, select Wiki. If Wiki is not listed in the left sidebar, a project administrator has disabled it.

GitLab wikis support Markdown, RDoc, AsciiDoc, and Org for content. Wiki pages written in Markdown support all Markdown features, and also provide some wiki-specific behavior for links.

In GitLab 13.5 and later, wiki pages display a sidebar, which you can customize. This sidebar contains a partial list of pages in the wiki, displayed as a nested tree, with sibling pages listed in alphabetical order. To view a list of all pages, select View All Pages in the sidebar:

Wiki sidebar

Configure a default branch for your wiki

Introduced in GitLab 14.1.

The default branch for your wiki repository depends on your version of GitLab:

  • GitLab versions 14.1 and later: Wikis inherit the default branch name configured for your instance or group. If no custom value is configured, GitLab uses main.
  • GitLab versions 14.0 and earlier: GitLab uses master.

For any version of GitLab, you can rename this default branch for previously created wikis.

Create the wiki home page

When a wiki is created, it is empty. On your first visit, you can create the home page users see when viewing the wiki. This page requires a specific title to be used as your wiki's home page. To create it:

  1. Go to your project or group and select Wiki.
  2. Select Create your first page.
  3. GitLab requires this first page be titled home. The page with this title serves as the front page for your wiki.
  4. Select a Format for styling your text.
  5. Add a welcome message for your home page in the Content section. You can always edit it later.
  6. Add a Commit message. Git requires a commit message, so GitLab creates one if you don't enter one yourself.
  7. Select Create page.

Create a new wiki page

Users with the Developer role can create new wiki pages:

  1. Go to your project or group and select Wiki.
  2. Select New page on this page, or any other wiki page.
  3. Select a content format.
  4. Add a title for your new page. Page titles use special characters for subdirectories and formatting, and have length restrictions.
  5. Add content to your wiki page.
  6. (Optional) Attach a file, and GitLab stores it according to your installed version of GitLab:
    • Files added in GitLab 11.3 and later: Files are stored in the wiki's Git repository.
    • Files added GitLab 11.2 and earlier: Files are stored in GitLab itself. To add the file to the wiki's Git repository, you must re-upload the file.
  7. Add a Commit message. Git requires a commit message, so GitLab creates one if you don't enter one yourself.
  8. Select Create page.

Create or edit wiki pages locally

Wikis are based on Git repositories, so you can clone them locally and edit them like you would do with every other Git repository. To clone a wiki repository locally, select Clone repository from the right-hand sidebar of any wiki page, and follow the on-screen instructions.

Files you add to your wiki locally must use one of the following supported extensions, depending on the markup language you wish to use. Files with unsupported extensions don't display when pushed to GitLab:

  • Markdown extensions: .mdown, .mkd, .mkdn, .md, .markdown.
  • AsciiDoc extensions: .adoc, .ad, .asciidoc.
  • Other markup extensions: .textile, .rdoc, .org, .creole, .wiki, .mediawiki, .rst.

Special characters in page titles

Wiki pages are stored as files in a Git repository, so certain characters have a special meaning:

  • Spaces are converted into hyphens when storing a page.
  • Hyphens (-) are converted back into spaces when displaying a page.
  • Slashes (/) are used as path separators, and can't be displayed in titles. If you create a title containing / characters, GitLab creates all the subdirectories needed to build that path. For example, a title of docs/my-page creates a wiki page with a path /wikis/docs/my-page.

Length restrictions for file and directory names

Introduced in GitLab 12.8.

Many common file systems have a limit of 255 bytes for file and directory names. Git and GitLab both support paths exceeding those limits. However, if your file system enforces these limits, you cannot check out a local copy of a wiki that contains filenames exceeding this limit. To prevent this problem, the GitLab web interface and API enforce these limits:

  • 245 bytes for page titles (reserving 10 bytes for the file extension).
  • 255 bytes for directory names.

Non-ASCII characters take up more than one byte.

While you can still create files locally that exceed these limits, your teammates may not be able to check out the wiki locally afterward.

Edit a wiki page

You need at least the Developer role to edit a wiki page:

  1. Go to your project or group and select Wiki.
  2. Go to the page you want to edit.
  3. Select the edit icon ({pencil}).
  4. Edit the content.
  5. Select Save changes.

Create a table of contents

To generate a table of contents from a wiki page's subheadings, use the [[_TOC_]] tag. For an example, read Table of contents.

Delete a wiki page

You need at least the Maintainer role to delete a wiki page:

  1. Go to your project or group and select Wiki.
  2. Go to the page you want to delete.
  3. Select the edit icon ({pencil}).
  4. Select Delete page.
  5. Confirm the deletion.

Move a wiki page

You need at least the Developer role to move a wiki page:

  1. Go to your project or group and select Wiki.
  2. Go to the page you want to move.
  3. Select the edit icon ({pencil}).
  4. Add the new path to the Title field. For example, if you have a wiki page called about under company and you want to move it to the wiki's root, change the Title from about to /about.
  5. Select Save changes.

View history of a wiki page

The changes of a wiki page over time are recorded in the wiki's Git repository. To view the changes for a wiki page, select Page history.

From the history page you can see:

Wiki page history

  • The revision (Git commit SHA) of the page.
  • The page author.
  • The commit message.
  • The last update.
  • Previous revisions, by selecting a revision number in the Page version column.

View changes between page versions

Introduced in GitLab 13.2.

You can see the changes made in a version of a wiki page, similar to versioned diff file views:

  1. Go to your project or group and select Wiki.

  2. Go to the wiki page you're interested in.

  3. Select Page history to see all page versions.

  4. Select the commit message in the Changes column for the version you're interested in.

    Wiki page changes

Track wiki events

GitLab tracks wiki creation, deletion, and update events. These events are displayed on the user profile, group, and project activity pages.

Commits to wikis are not counted in repository analytics.

Customize sidebar

Introduced in GitLab 13.8, the sidebar can be customized by selecting the Edit sidebar button.

You need at least the Developer role to customize the wiki navigation sidebar. This process creates a wiki page named _sidebar which fully replaces the default sidebar navigation:

  1. Go to your project or group and select Wiki.
  2. In the top right corner of the page, select Edit sidebar.
  3. When complete, select Save changes.

A _sidebar example, formatted with Markdown:

### [Home](home)

- [Hello World](hello)
- [Foo](foo)
- [Bar](bar)

---

- [Sidebar](_sidebar)

Support for displaying a generated table of contents with a custom side navigation is being considered.

Enable or disable a project wiki

Wikis are enabled by default in GitLab. Project administrators can enable or disable the project wiki by following the instructions in Sharing and permissions.

Administrators for self-managed GitLab installs can configure additional wiki settings.

Group wikis (PREMIUM)

Introduced in GitLab Premium 13.5.

Group wikis work the same way as project wikis. Their usage is similar to project wikis, with a few limitations:

  • Git LFS is not supported.
  • Group wikis are not included in global search.
  • Changes to group wikis don't show up in the group's activity feed.

For updates, follow the epic that tracks feature parity with project wikis.

Group wikis can be edited by members with the Developer role and above. Group wiki repositories can be moved using the Group repository storage moves API.

Export a group wiki (PREMIUM)

Users with the Owner role in a group can import and export group wikis when importing or exporting a group.

Content created in a group wiki is not deleted when an account is downgraded or a GitLab trial ends.

Link an external wiki

To add a link to an external wiki from a project's left sidebar:

  1. Go to your project and select Settings > Integrations.
  2. Select External wiki.
  3. Add the URL to your external wiki.
  4. (Optional) Select Test settings to verify the connection.
  5. Select Save changes.

You can now see the External wiki option from your project's left sidebar.

When you enable this integration, the link to the external wiki doesn't replace the link to the internal wiki. To hide the internal wiki from the sidebar, disable the project's wiki.

To hide the link to an external wiki:

  1. Go to your project and select Settings > Integrations.
  2. Select External wiki.
  3. In the Enable integration section, clear the Active checkbox.
  4. Select Save changes.

Disable the project's wiki

To disable a project's internal wiki:

  1. Go to your project and select Settings > General.
  2. Expand Visibility, project features, permissions.
  3. Scroll down to find Wiki and toggle it off (in gray).
  4. Select Save changes.

The internal wiki is now disabled, and users and project members:

  • Cannot find the link to the wiki from the project's sidebar.
  • Cannot add, delete, or edit wiki pages.
  • Cannot view any wiki page.

Previously added wiki pages are preserved in case you want to re-enable the wiki. To re-enable it, repeat the process to disable the wiki but toggle it on (in blue).

Content Editor (FREE)

Introduced in GitLab 14.0.

GitLab version 14.0 introduces a WYSIWYG editing experience for GitLab Flavored Markdown in Wikis through the Content Editor. The Content Editor is under active development, and is not yet the default editing experience in the Wiki. To opt in for the new editor:

  1. Create a new wiki page, or edit an existing one.

  2. Ensure the wiki page uses the Markdown format. Other formats are not yet supported.

  3. Below the Format select box, select Use the new editor:

    Use new editor button image

Use the Content Editor

  1. Create a new wiki page, or edit an existing one.

  2. Select Markdown as your format.

  3. Below the Format select box, select Use new editor.

  4. Customize your page's content using the various formatting options available in the content editor.

  5. Select Create page for a new page, or Save changes for an existing page:

    Content Editor in Wikis image

Switch back to the old editor

  1. If you're editing the page in the content editor, scroll to Content.
  2. Select Switch me back to the classic editor.
  3. Select Switch to classic editor in the confirmation popup to confirm.

When you switch back to the old editor, any unsaved changes are lost.

GitLab Flavored Markdown support

Supporting all GitLab Flavored Markdown content types in the Content Editor is a work in progress. For the status of the ongoing development for CommonMark and GitLab Flavored Markdown support, read:

Resources