Wiki-specific Markdown | GitLab Docs Skip to main content Go to GitLab Docs homepage What's new? What's new? Get free trial Toggle menu * Use GitLab * GitLab Duo * GitLab Orbit * Extend * Install * Administer * Subscribe * Contribute * Solutions Getting started Tutorials Manage your organization Organize work with projects Plan and track work Getting started Tutorials Tutorial: Use GitLab for Scrum Tutorial: Use GitLab for Kanban Work items Labels Iterations Milestones Comments and threads Requirements Time tracking Customer relations (CRM) Wikis Roadmaps Objectives and key results (OKR) Keyboard shortcuts Quick actions Markdown Rich text editor Wiki-specific Markdown AsciiDoc Org mode To-Do List GitLab Query Language (GLQL) Manage authentication and authorization Use Git Manage your code Use CI/CD to build your application Secure your application Deploy and release your application Manage your infrastructure Monitor your application Analyze GitLab usage Release notes Feature support Find your GitLab version * GitLab Docs / * Use GitLab / * Plan and track work / * Markdown / * Wiki-specific Markdown Help us learn about your current experience with the documentation. Take the survey . Wiki-specific Markdown * Tier : Free, Premium, Ultimate * Offering : GitLab.com, GitLab Self-Managed, GitLab Dedicated Links The following topics show how links inside wikis behave. When you link to wiki pages, use the page slug rather than the page name. A page slug is the URL-friendly version of the page title, where spaces are replaced with hyphens and special characters are removed or converted. For example, a page titled How to Use GitLab has the slug How-to-Use-GitLab . Wiki-style links In addition to standard Markdown links , wikis support special wiki-style link syntax that simplifies linking between wiki pages. Double bracket syntax You can link to wiki pages using double brackets: [[Home]] This syntax creates a link to a wiki page with the slug Home . If the page doesn t exist, when you select the link, you can create this page. When the page slug contains hyphens, the link displays the slug as-is: [[Home-page-new-slug]] This displays Home-page-new-slug as the link text. Double bracket syntax with custom text If the page slug is different from the title you want to display, use the pipe ( | ) character to separate the display text from the page slug: [[How to use GitLab|how-to-use-gitlab]] This displays How to use GitLab as the link text, but links to the page with the slug how-to-use-gitlab . You can also use this syntax to provide a more readable title for pages with hyphenated slugs: [[Home page (renamed)|Home-page-new-slug]] This displays Home page (renamed) as the link text, but links to the page with the slug Home-page-new-slug . Alternative wiki page syntax You can also use the [wiki_page:PAGE_SLUG] syntax: [wiki_page:Home] For cross-project references, specify the full project path: [wiki_page:namespace/project:Home] [wiki_page:group1/subgroup:Home] Automatic URL recognition When you paste a full URL to a wiki page without any Markdown formatting, GitLab automatically converts it to a link and displays the page slug with spaces instead of hyphens: https://gitlab.com/namespace/project/-/wikis/Home-page-new-slug This automatically renders as a link with the text Home page new slug (hyphens converted to spaces). 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. This example links to a documentation page at the root of your wiki: [ Link to Documentation ]( documentation-top-page ) Direct file link A direct file link points to a file extension for a file, relative to the current page. If the following example is on a page at <your_wiki>/documentation/related , it links to <your_wiki>/documentation/file.md : [ Link to File ]( file.md ) Hierarchical link A hierarchical link can be constructed relative to the current wiki page by using relative paths like ./<page> or ../<page> . If this example is on a page at <your_wiki>/documentation/main , it links to <your_wiki>/documentation/related : [ Link to Related Page ]( related ) If this example is on a page at <your_wiki>/documentation/related/content , it links to <your_wiki>/documentation/main : [ Link to Related Page ]( ../main ) If this example is on a page at <your_wiki>/documentation/main , it links to <your_wiki>/documentation/related.md : [ Link to Related Page ]( related.md ) If this example is on a page at <your_wiki>/documentation/related/content , it links to <your_wiki>/documentation/main.md : [ Link to Related Page ]( ../main.md ) Root link A root link starts with a / and is relative to the wiki root. This example links to <wiki_root>/documentation : [ Link to Related Page ]( /documentation ) This example links to <wiki_root>/documentation.md : [ Link to Related Page ]( /documentation.md ) diagrams.net editor In wikis, you can use the diagrams.net editor to create diagrams. You can also edit diagrams created with the diagrams.net editor. The diagram editor is available in both the plain text editor and the rich text editor. For more information, see Diagrams.net . Plain text editor To create a diagram in the plain text editor: * On the wiki page you want to edit, select Edit . * In the text box, make sure you re using the plain text editor (the button on the bottom left says Switch to rich text editing ). * In the editor s toolbar, select Insert or edit diagram ( ). * Create the diagram in the app.diagrams.net editor. * Select Save & exit . A Markdown image reference to the diagram is inserted in the wiki content. To edit a diagram in the plain text editor: * On the wiki page you want to edit, select Edit . * In the text box, make sure you re using the plain text editor (the button on the bottom left says Switch to rich text editing ). * Position your cursor in the Markdown image reference that contains the diagram. * Select Insert or edit diagram ( ). * Edit the diagram in the app.diagrams.net editor. * Select Save & exit . A Markdown image reference to the diagram is inserted in the wiki content, replacing the previous diagram. Rich text editor To create a diagram in the rich text editor: * On the wiki page you want to edit, select Edit . * In the text box, make sure you re using the rich text editor (the button on the bottom left says Switch to plain text editing ). * In the editor s toolbar, select More options ( ). * In the dropdown list, select Create or edit diagram . * Create the diagram in the app.diagrams.net editor. * Select Save & exit . The diagram as visualized in the diagrams.net editor is inserted in the wiki content. To edit a diagram in the rich text editor: * On the wiki page you want to edit, select Edit . * In the text box, make sure you re using the rich text editor (the button on the bottom left says Switch to plain text editing ). * Select the diagram that you want to edit. * In the floating toolbar, select Edit diagram ( ). * Edit the diagram in the app.diagrams.net editor. * Select Save & exit . The selected diagram is replaced with an updated version. * Links * Wiki-style links * Double bracket syntax * Double bracket syntax with custom text * Alternative wiki page syntax * Automatic URL recognition * Direct page link * Direct file link * Hierarchical link * Root link * diagrams.net editor * Plain text editor * Rich text editor * Facebook * LinkedIn * Twitter * YouTube Company * About GitLab * View pricing * Try GitLab for free Feedback * View page source * Edit in Web IDE * Contribute to GitLab * Suggest updates Help & Community * Get certified * Get support * Post on the GitLab forum Resources * Terms * Privacy statement * Use of generative AI * Acceptable use of user licenses *