summaryrefslogtreecommitdiff
path: root/doc/markdown/wiki.md
blob: d9e6d071b9f59fa25cb3e77de9b61c27fb953117 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# Wiki-specific Markdown

This page has information related to wiki-specific Markdown. For more
information on GitLab's Markdown, see the [main Markdown document](./markdown.md).

## Table of contents

* [Links to other wiki pages](#links-to-other-wiki-pages)
  * [Direct page link](#direct-page-link)
  * [Direct file link](#direct-file-link)
  * [Hierarchical link](#hierarchical-link)
  * [Root link](#root-link)

## Links to other wiki pages

You can link to other pages on your wiki in a few different ways.

### Direct page link

A link which just includes the slug for a page will point to that page,
_at the base level of the wiki_.

This snippet would link to a `documentation` page at the root of your wiki:

```markdown
[Link to Documentation](documentation)
```

### Direct file link

Links with a file extension point to that file, _relative to the current page_.

If this snippet was placed on a page at `<your_wiki>/documentation/related`,
it would link to `<your_wiki>/documentation/file.md`:

```markdown
[Link to File](file.md)
```

### Hierarchical link

A link can be constructed relative to the current wiki page using `./<page>`,
`../<page>`, etc.

- If this snippet was placed on a page at `<your_wiki>/documentation/main`,
  it would link to `<your_wiki>/documentation/related`:

	```markdown
	[Link to Related Page](./related)
	```

- If this snippet was placed on a page at `<your_wiki>/documentation/related/content`,
  it would link to `<your_wiki>/documentation/main`:

	```markdown
	[Link to Related Page](../main)
	```

- If this snippet was placed on a page at `<your_wiki>/documentation/main`,
  it would link to `<your_wiki>/documentation/related.md`:

	```markdown
	[Link to Related Page](./related.md)
	```

- If this snippet was placed on a page at `<your_wiki>/documentation/related/content`,
  it would link to `<your_wiki>/documentation/main.md`:

	```markdown
	[Link to Related Page](../main.md)
	```

### Root link

A link starting with a `/` is relative to the wiki root.

- This snippet links to `<wiki_root>/documentation`:

	```markdown
	[Link to Related Page](/documentation)
	```

- This snippet links to `<wiki_root>/miscellaneous.md`:

	```markdown
	[Link to Related Page](/miscellaneous.md)
	```