diff options
author | Robert Speicher <robert@gitlab.com> | 2016-03-10 19:25:31 +0000 |
---|---|---|
committer | Robert Speicher <robert@gitlab.com> | 2016-03-10 19:25:31 +0000 |
commit | b886d833d3835bc0204fd3ed8f9a00fdf3c27ed1 (patch) | |
tree | 1c1da4985c6695847857c685673ff1e431997e87 | |
parent | 5c1dba671dbfbd8a20b014b5548cc07ce5641e9b (diff) | |
parent | b04020506d6e7b641427763b0052c8b7582db9b7 (diff) | |
download | gitlab-ce-b886d833d3835bc0204fd3ed8f9a00fdf3c27ed1.tar.gz |
Merge branch 'markdown-parser-documentation' into 'master'
Adds mention of Redcarpet as Markdown parser in docs
It makes it easier for users to find the source of issues related to
Markdown parsing.
[ci skip]
See merge request !3168
-rw-r--r-- | doc/markdown/markdown.md | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/markdown/markdown.md b/doc/markdown/markdown.md index cbf57db5684..e6eb1cf3819 100644 --- a/doc/markdown/markdown.md +++ b/doc/markdown/markdown.md @@ -29,6 +29,8 @@ ## GitLab Flavored Markdown (GFM) +_GitLab uses the [Redcarpet Ruby library][redcarpet] for Markdown processing._ + For GitLab we developed something we call "GitLab Flavored Markdown" (GFM). It extends the standard Markdown in a few significant ways to add some useful functionality. You can use GFM in @@ -88,8 +90,8 @@ GFM will autolink almost any URL you copy and paste into your text. ## Code and Syntax Highlighting -_GitLab uses the [rouge ruby library][rouge] for syntax highlighting. For a -list of supported languages visit the rouge website._ +_GitLab uses the [Rouge Ruby library][rouge] for syntax highlighting. For a +list of supported languages visit the Rouge website._ Blocks of code are either fenced by lines with three back-ticks <code>```</code>, or are indented with four spaces. Only the fenced code blocks support syntax highlighting. @@ -591,3 +593,4 @@ By including colons in the header row, you can align the text within that column - [Dillinger.io](http://dillinger.io) is a handy tool for testing standard markdown. [rouge]: http://rouge.jneen.net/ "Rouge website" +[redcarpet]: https://github.com/vmg/redcarpet "Redcarpet website" |