From 02809e1cf874122bab3e269ae7362be3ad8a87bd Mon Sep 17 00:00:00 2001 From: Robert Speicher Date: Mon, 6 Apr 2015 12:16:18 -0400 Subject: Add more GFM reference examples to docs --- doc/markdown/markdown.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/markdown/markdown.md b/doc/markdown/markdown.md index 1d5fd4c8b0d..5c8b161cb6c 100644 --- a/doc/markdown/markdown.md +++ b/doc/markdown/markdown.md @@ -176,14 +176,18 @@ GFM will recognize the following: - #123 : for issues - !123 : for merge requests - $123 : for snippets -- 1234567 : for commits +- ~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@1234567 : for commits +- namespace/project$123 : for snippets +- namespace/project@9ba12248 : for specific commits +- namespace/project@9ba12248...b19a04f5 : for commit range comparisons ## Task Lists -- cgit v1.2.1 From b595249462346d48817330baf8c253b6f08690a1 Mon Sep 17 00:00:00 2001 From: Robert Speicher Date: Fri, 17 Apr 2015 12:15:10 -0400 Subject: Update markdown docs with latest references MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Also, tables! (╯°□°）╯︵ ┻━┻) --- doc/markdown/markdown.md | 43 +++++++++++++++++++++++++------------------ 1 file changed, 25 insertions(+), 18 deletions(-) (limited to 'doc') 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 -- cgit v1.2.1