Commit b5952494 authored by Robert Speicher's avatar Robert Speicher

Update markdown docs with latest references

Also, tables! (╯°□°)╯︵ ┻━┻)
parent 2823c058
...@@ -163,7 +163,7 @@ Consult the [Emoji Cheat Sheet](http://emoji.codes) for a list of all supported ...@@ -163,7 +163,7 @@ Consult the [Emoji Cheat Sheet](http://emoji.codes) for a list of all supported
## Special GitLab References ## 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. 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 ...@@ -171,23 +171,30 @@ GFM will turn that reference into a link so you can navigate between them easily
GFM will recognize the following: GFM will recognize the following:
- @foo : for specific team members or groups | input | references |
- @all : for the whole team |-----------------------:|:---------------------------|
- #123 : for issues | `@user_name` | specific user |
- !123 : for merge requests | `@group_name` | specific group |
- $123 : for snippets | `@all` | entire team |
- ~123 : for labels | `#123` | issue |
- 9ba12248 : for specific commits | `!123` | merge request |
- 9ba12248...b19a04f5 : for commit range comparisons | `$123` | snippet |
- \[file\](path/to/file) : for file references | `~123` | label by ID |
| `~bug` | one-word label by name |
GFM also recognizes references to commits, issues, and merge requests in other projects: | `~"feature request"` | multi-word label by name |
| `9ba12248` | specific commit |
- namespace/project#123 : for issues | `9ba12248...b19a04f5` | commit range comparison |
- namespace/project!123 : for merge requests | `[README](doc/README)` | repository file references |
- namespace/project$123 : for snippets
- namespace/project@9ba12248 : for specific commits GFM also recognizes certain cross-project references:
- namespace/project@9ba12248...b19a04f5 : for commit range comparisons
| 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 ## Task Lists
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment