summaryrefslogtreecommitdiff
path: root/doc/markdown
diff options
context:
space:
mode:
authorRobert Speicher <rspeicher@gmail.com>2015-04-17 12:15:10 -0400
committerRobert Speicher <rspeicher@gmail.com>2015-04-20 13:01:47 -0400
commitb595249462346d48817330baf8c253b6f08690a1 (patch)
tree038c2ee2c0dd8a24d7475dd7b22db439568b4f7c /doc/markdown
parent2823c058d8cff59f10f57a106e0e1e4e3c0b2870 (diff)
downloadgitlab-ce-b595249462346d48817330baf8c253b6f08690a1.tar.gz
Update markdown docs with latest references
Also, tables! (╯°□°)╯︵ ┻━┻)
Diffstat (limited to 'doc/markdown')
-rw-r--r--doc/markdown/markdown.md43
1 files changed, 25 insertions, 18 deletions
diff --git a/doc/markdown/markdown.md b/doc/markdown/markdown.md
index 5c8b161cb6c..8ec5a20035f 100644
--- a/doc/markdown/markdown.md
+++ b/doc/markdown/markdown.md
@@ -163,7 +163,7 @@ Consult the [Emoji Cheat Sheet](http://emoji.codes) for a list of all supported
## Special GitLab References
-GFM recognized special references.
+GFM recognizes special references.
You can easily reference e.g. an issue, a commit, a team member or even the whole team within a project.
@@ -171,23 +171,30 @@ GFM will turn that reference into a link so you can navigate between them easily
GFM will recognize the following:
-- @foo : for specific team members or groups
-- @all : for the whole team
-- #123 : for issues
-- !123 : for merge requests
-- $123 : for snippets
-- ~123 : for labels
-- 9ba12248 : for specific commits
-- 9ba12248...b19a04f5 : for commit range comparisons
-- \[file\](path/to/file) : for file references
-
-GFM also recognizes references to commits, issues, and merge requests in other projects:
-
-- namespace/project#123 : for issues
-- namespace/project!123 : for merge requests
-- namespace/project$123 : for snippets
-- namespace/project@9ba12248 : for specific commits
-- namespace/project@9ba12248...b19a04f5 : for commit range comparisons
+| input | references |
+|-----------------------:|:---------------------------|
+| `@user_name` | specific user |
+| `@group_name` | specific group |
+| `@all` | entire team |
+| `#123` | issue |
+| `!123` | merge request |
+| `$123` | snippet |
+| `~123` | label by ID |
+| `~bug` | one-word label by name |
+| `~"feature request"` | multi-word label by name |
+| `9ba12248` | specific commit |
+| `9ba12248...b19a04f5` | commit range comparison |
+| `[README](doc/README)` | repository file references |
+
+GFM also recognizes certain cross-project references:
+
+| input | references |
+|----------------------------------------:|:------------------------|
+| `namespace/project#123` | issue |
+| `namespace/project!123` | merge request |
+| `namespace/project$123` | snippet |
+| `namespace/project@9ba12248` | specific commit |
+| `namespace/project@9ba12248...b19a04f5` | commit range comparison |
## Task Lists