Gitlab Markdown help page

randx
1 parent 72c6be2d
Showing 4 changed files with 32 additions and 2 deletions Show diff stats
app/views/help/index.html.haml
app/views/help/markdown.html.haml
app/views/notes/_form.html.haml
config/routes.rb
@@ -28,3 +28,6 @@
  
   %li
     %h5= link_to "API", help_api_path
+
+  %li
+    %h5= link_to "Gitlab Markdown", help_markdown_path
@@ -0,0 +1,25 @@
+- bash_lexer = Pygments::Lexer[:bash]
+%h3.page_title Gitlab Markdown
+.back_link
+  = link_to help_path do 
+    &larr; to index
+%hr
+
+%p.slead We extend Markdown with some GITLAB specific syntax. It allows you to link to:
+
+%ul
+  %li issues (#123)
+  %li merge request (!123)
+  %li commits (1234567)
+  %li team members (@foo)
+  %li snippets ($123)
+
+%p.slead in
+
+%ul
+  %li commit messages
+  %li notes/comments/wall posts
+  %li issues
+  %li merge requests
+  %li milestones
+  %li wiki pages
@@ -8,7 +8,9 @@
   = f.hidden_field :noteable_id
   = f.hidden_field :noteable_type
   = f.text_area :note,  :size => 255
-  %p.hint Markdown is enabled.
+  %p.hint
+    = link_to "Gitlab Markdown", help_markdown_path, :target => '_blank'
+    is enabled.
  
   .row.note_advanced_opts.hide
     .span4
@@ -31,5 +33,4 @@
           .input= f.file_field :attachment, :class => "input-file"
         %span Any file less than 10 MB
  
-
   = f.submit 'Add Comment', :class => "btn primary submit_note", :id => "submit_note"
@@ -29,6 +29,7 @@ Gitlab::Application.routes.draw do
   get 'help/api' => 'help#api'
   get 'help/web_hooks' => 'help#web_hooks'
   get 'help/system_hooks' => 'help#system_hooks'
+  get 'help/markdown' => 'help#markdown'
  
   #
   # Admin Area
...	...	@@ -28,3 +28,6 @@
28	28
29	29	%li
30	30	%h5= link_to "API", help_api_path
	31	+
	32	+ %li
	33	+ %h5= link_to "Gitlab Markdown", help_markdown_path
...	...
...	...	@@ -0,0 +1,25 @@
	1	+- bash_lexer = Pygments::Lexer[:bash]
	2	+%h3.page_title Gitlab Markdown
	3	+.back_link
	4	+ = link_to help_path do
	5	+ ← to index
	6	+%hr
	7	+
	8	+%p.slead We extend Markdown with some GITLAB specific syntax. It allows you to link to:
	9	+
	10	+%ul
	11	+ %li issues (#123)
	12	+ %li merge request (!123)
	13	+ %li commits (1234567)
	14	+ %li team members (@foo)
	15	+ %li snippets ($123)
	16	+
	17	+%p.slead in
	18	+
	19	+%ul
	20	+ %li commit messages
	21	+ %li notes/comments/wall posts
	22	+ %li issues
	23	+ %li merge requests
	24	+ %li milestones
	25	+ %li wiki pages
...	...
...	...	@@ -8,7 +8,9 @@
8	8	= f.hidden_field :noteable_id
9	9	= f.hidden_field :noteable_type
10	10	= f.text_area :note, :size => 255
11		- %p.hint Markdown is enabled.
	11	+ %p.hint
	12	+ = link_to "Gitlab Markdown", help_markdown_path, :target => '_blank'
	13	+ is enabled.
12	14
13	15	.row.note_advanced_opts.hide
14	16	.span4
...	...	@@ -31,5 +33,4 @@
31	33	.input= f.file_field :attachment, :class => "input-file"
32	34	%span Any file less than 10 MB
33	35
34		-
35	36	= f.submit 'Add Comment', :class => "btn primary submit_note", :id => "submit_note"
...	...
...	...	@@ -29,6 +29,7 @@ Gitlab::Application.routes.draw do
29	29	get 'help/api' => 'help#api'
30	30	get 'help/web_hooks' => 'help#web_hooks'
31	31	get 'help/system_hooks' => 'help#system_hooks'
	32	+ get 'help/markdown' => 'help#markdown'
32	33
33	34	#
34	35	# Admin Area
...	...