diff options
| author | Robert Speicher <rspeicher@gmail.com> | 2015-04-27 22:01:46 -0400 |
|---|---|---|
| committer | Robert Speicher <rspeicher@gmail.com> | 2015-04-30 16:35:26 -0400 |
| commit | 588267b5e27238cdf406f248db7cc83b9b0881c8 (patch) | |
| tree | f320fe23fb428b31ac7fda18a937e47a3ffc2dc5 /lib | |
| parent | e46d1cdd8bd4cc12e8c8e8fdce10b3114a17d95e (diff) | |
| download | gitlab-ce-588267b5e27238cdf406f248db7cc83b9b0881c8.tar.gz | |
Update the Gitlab::Markdown docs
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/gitlab/markdown.rb | 26 |
1 files changed, 1 insertions, 25 deletions
diff --git a/lib/gitlab/markdown.rb b/lib/gitlab/markdown.rb index e7ddaab5c2a..8348e28d0f5 100644 --- a/lib/gitlab/markdown.rb +++ b/lib/gitlab/markdown.rb @@ -3,31 +3,7 @@ require 'html/pipeline' module Gitlab # Custom parser for GitLab-flavored Markdown # - # It replaces references in the text with links to the appropriate items in - # GitLab. - # - # Supported reference formats are: - # * @foo for team members - # * #123 for issues - # * JIRA-123 for Jira issues - # * !123 for merge requests - # * $123 for snippets - # * 1c002d for specific commit - # * 1c002d...35cfb2 for commit ranges (comparisons) - # - # It also parses Emoji codes to insert images. See - # http://www.emoji-cheat-sheet.com/ for a list of the supported icons. - # - # Examples - # - # >> gfm("Hey @david, can you fix this?") - # => "Hey <a href="/u/david">@david</a>, can you fix this?" - # - # >> gfm("Commit 35d5f7c closes #1234") - # => "Commit <a href="/gitlab/commits/35d5f7c">35d5f7c</a> closes <a href="/gitlab/issues/1234">#1234</a>" - # - # >> gfm(":trollface:") - # => "<img alt=\":trollface:\" class=\"emoji\" src=\"/images/trollface.png" title=\":trollface:\" /> + # See the files in `lib/gitlab/markdown/` for specific processing information. module Markdown # Provide autoload paths for filters to prevent a circular dependency error autoload :AutolinkFilter, 'gitlab/markdown/autolink_filter' |