diff options
author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-08-02 13:34:49 +0300 |
---|---|---|
committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-08-02 13:34:49 +0300 |
commit | 4611191785f2ca0eca2ba5be3b24224879bc5c50 (patch) | |
tree | df0ef34aeedb117d465269a020e0523a1f0db395 | |
parent | 97c61900e4bd764fa772f349a2996d8d940795b1 (diff) |
Merge wiki-specific Markdown in main Markdown file
-rw-r--r-- | doc/markdown/markdown.md | 82 | ||||
-rw-r--r-- | doc/markdown/wiki.md | 87 |
2 files changed, 80 insertions, 89 deletions
diff --git a/doc/markdown/markdown.md b/doc/markdown/markdown.md index e4101fa5388..d7f09ec070c 100644 --- a/doc/markdown/markdown.md +++ b/doc/markdown/markdown.md @@ -28,9 +28,12 @@ * [Line Breaks](#line-breaks) * [Tables](#tables) -**[Wiki-Specific Markdown](wiki.md)** +**[Wiki-Specific Markdown](#wiki-specific-markdown)** -* [Links](wiki.md#links-to-other-wiki-pages) +* [Wiki - Direct page link](#wiki-direct-page-link) +* [Wiki - Direct file link](#wiki-direct-file-link) +* [Wiki - Hierarchical link](#wiki-hierarchical-link) +* [Wiki - Root link](#wiki-root-link) **[References](#references)** @@ -696,6 +699,81 @@ By including colons in the header row, you can align the text within that column | Cell 1 | Cell 2 | Cell 3 | Cell 4 | Cell 5 | Cell 6 | | Cell 7 | Cell 8 | Cell 9 | Cell 10 | Cell 11 | Cell 12 | + +## Wiki-specific Markdown + +The following examples show how links inside wikis behave. + +### Wiki - 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) +``` + +### Wiki - 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) +``` + +### Wiki - 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) + ``` + +### Wiki - 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) + ``` ## References - This document leveraged heavily from the [Markdown-Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet). diff --git a/doc/markdown/wiki.md b/doc/markdown/wiki.md deleted file mode 100644 index d9e6d071b9f..00000000000 --- a/doc/markdown/wiki.md +++ /dev/null @@ -1,87 +0,0 @@ -# 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) - ``` |