GitHub Flavored Markdown Examples · Issue #1 · mojombo/github-flavored-markdown · GitHub
Skip to content

/ github-flavored-markdown

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

GitHub Flavored Markdown Examples #1

Closed
mojombo opened this issue Apr 21, 2009 · 65 comments
Closed

GitHub Flavored Markdown Examples #1

mojombo opened this issue Apr 21, 2009 · 65 comments

Comments

@mojombo
Copy link
Owner

@mojombo mojombo commented Apr 21, 2009

GitHub Flavored Markdown

View the source of this content.

Let's get the whole "linebreak" thing out of the way. The next paragraph contains two phrases separated by a single newline character:

Roses are red
Violets are blue

The next paragraph has the same phrases, but now they are separated by two spaces and a newline character:

Roses are red
Violets are blue

Oh, and one thing I cannot stand is the mangling of words with multiple underscores in them like perform_complicated_task or do_this_and_do_that_and_another_thing.

A bit of the GitHub spice

In addition to the changes in the previous section, certain references are auto-linked:

These are dangerous goodies though, and we need to make sure email addresses don't get mangled:

My email addy is tom@github.com.

Math is hard, let's go shopping

In first grade I learned that 5 > 3 and 2 < 7. Maybe some arrows. 1 -> 2 -> 3. 9 <- 8 <- 7.

Triangles man! a^2 + b^2 = c^2

We all like making lists

The above header should be an H2 tag. Now, for a list of fruits:

  • Red Apples
  • Purple Grapes
  • Green Kiwifruits

Let's get crazy:

  1. This is a list item with two paragraphs. Lorem ipsum dolor
    sit amet, consectetuer adipiscing elit. Aliquam hendrerit
    mi posuere lectus.

Vestibulum enim wisi, viverra nec, fringilla in, laoreet
vitae, risus. Donec sit amet nisl. Aliquam semper ipsum
sit amet velit.
2. Suspendisse id sem consectetuer libero luctus adipiscing.

What about some code in a list? That's insane, right?

  1. In Ruby you can map like this:

    ['a', 'b'].map { |x| x.uppercase }

  2. In Rails, you can do a shortcut:

    ['a', 'b'].map(&:uppercase)

Some people seem to like definition lists

Lower cost
The new version of this product costs significantly less than the previous one!
Easier to use
We've changed the product so that it's much easier to use!

I am a robot

Maybe you want to print robot to the console 1000 times. Why not?

def robot_invasion
  puts("robot " * 1000)
end

You see, that was formatted as code because it's been indented by four spaces.

How about we throw some angle braces and ampersands in there?


    © 2004 Foo Corporation

Set in stone

Preformatted blocks are useful for ASCII art:

             ,-. 
    ,     ,-.   ,-. 
   / \   (   )-(   ) 
   \ |  ,.>-(   )-< 
    \|,' (   )-(   ) 
     Y ___`-'   `-' 
     |/__/   `-' 
     | 
     | 
     |    -hrr- 
  ___|_____________

Playing the blame game

If you need to blame someone, the best way to do so is by quoting them:

I, at any rate, am convinced that He does not throw dice.

Or perhaps someone a little less eloquent:

I wish you'd have given me this written question ahead of time so I
could plan for it... I'm sure something will pop into my head here in
the midst of this press conference, with all the pressure of trying to
come up with answer, but it hadn't yet...

I don't want to sound like
I have made no mistakes. I'm confident I have. I just haven't - you
just put me under the spot here, and maybe I'm not as quick on my feet
as I should be in coming up with one.

Table for two

IDNameRank
1Tom Preston-WernerAwesome
2Albert EinsteinNearly as awesome

Crazy linking action

I get 10 times more traffic from Google than from
Yahoo or MSN.

Also, shoop.
@kennethreitz
Copy link

@kennethreitz kennethreitz commented Dec 17, 2009

I want this in php!!!
@mojombo
Copy link
Owner Author

@mojombo mojombo commented Dec 17, 2009

Easy enough. Here's the Ruby code that we use. It should be simple to port to PHP.

http://gist.github.com/118964
@fgnass
Copy link

@fgnass fgnass commented Jan 21, 2010

Looks like the arrows/math example doesn't work.
@fgnass
Copy link

@fgnass fgnass commented Jan 21, 2010

Oh, therefore HTML (a subset?) seems to be supported in comments ;-)
@fgnass
Copy link

@fgnass fgnass commented Jan 22, 2010

Sorry my fault, I wasn't aware that Markdown also supports regular HTML tags.
Anyway, the a^2 and arrow -> syntax mentioned in the example doesn't seem to work.
@perj
Copy link

@perj perj commented Mar 17, 2010

Doesn't seem to parse valgrind reports very well, eg. http://github.com/facebook/hiphop-php/issues/#issue/50 a bit down. Nor gdb tracebacks for that matter.
@snoldak924
Copy link

@snoldak924 snoldak924 commented Aug 6, 2010

a^2 works for me, but not ->

Fedora 12, FF 3.5.11
@Archeleus
Copy link

@Archeleus Archeleus commented Nov 7, 2010

Yeah, arrows don't work.
@najamelan
Copy link

@najamelan najamelan commented Nov 23, 2010

any chance on images? Being able to upload a screenshot in an issue tracker is quite useful
@paradoxxxzero
Copy link

@paradoxxxzero paradoxxxzero commented Dec 24, 2010

For images : http://daringfireball.net/projects/markdown/syntax#img
@cjxgm
Copy link

@cjxgm cjxgm commented Jan 8, 2011

I like this feeling...

Maybe there's something wrong in the page.

Under Set in stone.

And -> doesn't work on my computer, too.

Yeah, I like to try these.

f(x) = sin(ax^2 ) + bx + c

OK

That's it!

  1. abcdef
    ghijklmnopq
  2. cdefg
  • abc
  • cde
@ekd123
Copy link

@ekd123 ekd123 commented Feb 1, 2011

B

I

_BI_

What is this?

xxx is same as xxx?
@woomla
Copy link

@woomla woomla commented Mar 7, 2011 

And this is ?
@Rosuav
Copy link

@Rosuav Rosuav commented Mar 20, 2011

Something seems to be wrong with the ASCII art example; I think it's coming out as code but not pre.
@carlosalexsander
Copy link

@carlosalexsander carlosalexsander commented Jul 28, 2011

[testing]
@carlosalexsander
Copy link

@carlosalexsander carlosalexsander commented Jul 28, 2011 

 teste
@dnadlinger
Copy link

@dnadlinger dnadlinger commented Sep 14, 2011

Isn't the above rendering pretty much broken?
@ghost
Copy link

@ghost ghost commented Oct 13, 2011

This Api's Tester
@sanek83
Copy link

@sanek83 sanek83 commented Nov 17, 2011

logo
@SethMilliken
Copy link

@SethMilliken SethMilliken commented Mar 15, 2012

Given that this page is offered as the primary example linked from the GitHub Flavored Markdown page, it would be great if it rendered correctly. So thanks to the wonderful fact that comments themselves use this very markdown, I've included a c&p of the corresponding referenced source (with the exception of the following minor fix, s/, in the 

 example which appears to be indicative of what is arguably a bug in the 
 parsing code):


Begin Example Source of Corrected 
 Section




             ,-. 
    ,     ,-.   ,-. 
   / \   (   )-(   ) 
   \ |  ,.>-(   )-< 
    \|,' (   )-(   ) 
     Y ___`-'   `-' 
     |/__/   `-' 
     | 
     | 
     |    -hrr- 
  ___|_____________ 





Begin Full Rendered Source




GitHub Flavored Markdown


View the source of this content.


Let's get the whole "linebreak" thing out of the way. The next paragraph contains two phrases separated by a single newline character:


Roses are red

Violets are blue


The next paragraph has the same phrases, but now they are separated by two spaces and a newline character:


Roses are red

Violets are blue


Oh, and one thing I cannot stand is the mangling of words with multiple underscores in them like perform_complicated_task or do_this_and_do_that_and_another_thing.


A bit of the GitHub spice


In addition to the changes in the previous section, certain references are auto-linked:



These are dangerous goodies though, and we need to make sure email addresses don't get mangled:


My email addy is tom@github.com.


Math is hard, let's go shopping


In first grade I learned that 5 > 3 and 2 < 7. Maybe some arrows. 1 -> 2 -> 3. 9 <- 8 <- 7.


Triangles man! a^2 + b^2 = c^2


We all like making lists


The above header should be an H2 tag. Now, for a list of fruits:


    

  • Red Apples
    • 

  • Purple Grapes
    • 

  • Green Kiwifruits
    • 



Let's get crazy:


    

  1. This is a list item with two paragraphs. Lorem ipsum dolor
    
sit amet, consectetuer adipiscing elit. Aliquam hendrerit
    
mi posuere lectus.
    2. 



Vestibulum enim wisi, viverra nec, fringilla in, laoreet

vitae, risus. Donec sit amet nisl. Aliquam semper ipsum

sit amet velit.

2.  Suspendisse id sem consectetuer libero luctus adipiscing.


What about some code in a list? That's insane, right?


    

  1. 

    In Ruby you can map like this:
    

    ['a', 'b'].map { |x| x.uppercase }

    

    2. 

  2. 

    In Rails, you can do a shortcut:
    

    ['a', 'b'].map(&:uppercase)

    

    3. 



Some people seem to like definition lists



  
Lower cost

  
The new version of this product costs significantly less than the previous one!

  
Easier to use

  
We've changed the product so that it's much easier to use!




I am a robot


Maybe you want to print robot to the console 1000 times. Why not?


def robot_invasion
  puts("robot " * 1000)
end



You see, that was formatted as code because it's been indented by four spaces.


How about we throw some angle braces and ampersands in there?



    © 2004 Foo Corporation





Set in stone


Preformatted blocks are useful for ASCII art:


             ,-. 
    ,     ,-.   ,-. 
   / \   (   )-(   ) 
   \ |  ,.>-(   )-< 
    \|,' (   )-(   ) 
     Y ___`-'   `-' 
     |/__/   `-' 
     | 
     | 
     |    -hrr- 
  ___|_____________ 



Playing the blame game


If you need to blame someone, the best way to do so is by quoting them:




I, at any rate, am convinced that He does not throw dice.




Or perhaps someone a little less eloquent:




I wish you'd have given me this written question ahead of time so I

could plan for it... I'm sure something will pop into my head here in

the midst of this press conference, with all the pressure of trying to

come up with answer, but it hadn't yet...


I don't want to sound like

I have made no mistakes. I'm confident I have. I just haven't - you

just put me under the spot here, and maybe I'm not as quick on my feet

as I should be in coming up with one.




Table for two



  

    IDNameRank
  

  

    1Tom Preston-WernerAwesome
  

  

    2Albert EinsteinNearly as awesome
  




Crazy linking action


I get 10 times more traffic from Google than from

Yahoo or MSN.
@panzi
Copy link

@panzi panzi commented Jul 1, 2012

The table feature seems to be broken. At least the tables here do not work:
https://github.com/panzi/SocialSharePrivacy

I'll test some things here:

Character Replacement
< <
> >
& &
" "
' '
Character Replacement
< <
> >
& &
" "
' '
@panzi
Copy link

@panzi panzi commented Jul 1, 2012

Character Replacement
< <
Character Replacement
< <
Character Replacement
Foo Bar
@panzi
Copy link

@panzi panzi commented Jul 1, 2012

Nope, completely broken.
@panzi
Copy link

@panzi panzi commented Jul 1, 2012

Last try:

Foo Bar
Egg Spam
@panzi
Copy link

@panzi panzi commented Jul 1, 2012

Or do all

s need to be in one line?

FooBar
FooBar
FooBar
FooBar
@FichteFoll
Copy link

@FichteFoll FichteFoll commented Jul 1, 2012

https://github.com/FichteFoll/sublimetext-insertdate/blob/master/README.md

Seems to be similar to the "MultiMarkDown" thing but I'm not sure about that and it just works. The alignments do not, apparently (the :----, :-----: ------: thing).

Edit: Plugin for Sublime Tex 2.
@panzi
Copy link

@panzi panzi commented Jul 1, 2012

Ok, then let me try this here:

Foo Bar
Egg Spam

... interestingly it shows the exact same problems as the version. My guess is that sometime in the last few days some update wrecked table support on github and that old files are cached rendered and thus still look right.

When you click on "Edit" and then on "Preview" in the README.md you linked you see the exact same thing.

@FichteFoll
Copy link

@FichteFoll FichteFoll commented Jul 24, 2012

Yeah, seems to be fixed now.
@tsatalos
Copy link

@tsatalos tsatalos commented Aug 18, 2012

It seems that un-necessary parsing happens within preformatted blocks < pre > ...< /pre >
For example the existance of a single '&' in the preformated block causes a parse error to be generated and the whole pre formatted block to become pink....

To avoid that you need to replace all your ampersands within pre with & amp ; ...
I am assuming that this is a parsing bug of the markdown library and not a standard behavior, correct?

odysseas
@yatharth
Copy link

@yatharth yatharth commented Aug 19, 2012

Broken

This soo doesn't work properly. And they still don't allow HTML inside code tags (which is probably a feature, not a bug). And as a previous commenter said:

Given that this page is offered as the primary example linked from the GitHub Flavored Markdown page, it would be great if it rendered correctly.

So I decided to try it on my own :)

GitHub Flavored Markdown

View the source of this content.

Let's get the whole "linebreak" thing out of the way. The next paragraph contains two phrases separated by a single newline character:

Roses are red
Violets are blue

The next paragraph has the same phrases, but now they are separated by two spaces and a newline character:

Roses are red
Violets are blue

Oh, and one thing I cannot stand is the mangling of words with multiple underscores in them like perform_complicated_task or do_this_and_do_that_and_another_thing.

A bit of the GitHub spice

In addition to the changes in the previous section, certain references are auto-linked:

These are dangerous goodies though, and we need to make sure email addresses don't get mangled:

My email addy is tom@github.com.

Math is hard, let's go shopping

In first grade I learned that 5 > 3 and 2 < 7. Maybe some arrows. 1 -> 2 -> 3. 9 <- 8 <- 7.

Triangles man! a^2 + b^2 = c^2

We all like making lists

The above header should be an H2 tag. Now, for a list of fruits:

  • Red Apples
  • Purple Grapes
  • Green Kiwifruits

Let's get crazy:

  1. This is a list item with two paragraphs. Lorem ipsum dolor
    sit amet, consectetuer adipiscing elit. Aliquam hendrerit
    mi posuere lectus.

Vestibulum enim wisi, viverra nec, fringilla in, laoreet
vitae, risus. Donec sit amet nisl. Aliquam semper ipsum
sit amet velit.
2. Suspendisse id sem consectetuer libero luctus adipiscing.

What about some code in a list? That's insane, right?

  1. In Ruby you can map like this:

    ['a', 'b'].map { |x| x.uppercase }

  2. In Rails, you can do a shortcut:

    ['a', 'b'].map(&:uppercase)

Some people seem to like definition lists

Lower cost
The new version of this product costs significantly less than the previous one!
Easier to use
We've changed the product so that it's much easier to use!

I am a robot

Maybe you want to print robot to the console 1000 times. Why not?

def robot_invasion
  puts("robot " * 1000)
end

You see, that was formatted as code because it's been indented by four spaces.

How about we throw some angle braces and ampersands in there?


    © 2004 Foo Corporation

Set in stone

Preformatted blocks are useful for ASCII art:

             ,-. 
    ,     ,-.   ,-. 
   / \   (   )-(   ) 
   \ |  ,.>-(   )-< 
    \|,' (   )-(   ) 
     Y ___`-'   `-' 
     |/__/   `-' 
     | 
     | 
     |    -hrr- 
  ___|_____________

Playing the blame game

If you need to blame someone, the best way to do so is by quoting them:

I, at any rate, am convinced that He does not throw dice.

Or perhaps someone a little less eloquent:

I wish you'd have given me this written question ahead of time so I
could plan for it... I'm sure something will pop into my head here in
the midst of this press conference, with all the pressure of trying to
come up with answer, but it hadn't yet...

I don't want to sound like
I have made no mistakes. I'm confident I have. I just haven't - you
just put me under the spot here, and maybe I'm not as quick on my feet
as I should be in coming up with one.

Table for two

IDNameRank
1Tom Preston-WernerAwesome
2Albert EinsteinNearly as awesome

Crazy linking action

I get 10 times more traffic from Google than from
Yahoo or MSN.
@sahapop2019 sahapop2019 mentioned this issue Feb 18, 2019
Open
@Std52800 Std52800 mentioned this issue Feb 18, 2019
Open
@Natthapan175 Natthapan175 mentioned this issue Feb 18, 2019
Open
@mamnattakan mamnattakan mentioned this issue Feb 18, 2019
Open
@timshaw9791 timshaw9791 mentioned this issue Mar 12, 2019
Open
@zyhcool zyhcool mentioned this issue Apr 29, 2019
Closed
3 of 4 tasks complete
laviole referenced this issue in expanse-org/go-expanse Aug 25, 2019
@mkrufky
Dockerfile: must copy gexp from builder
Verified
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: 4AEE18F83AFDEB23 Learn about vigilant mode.
Loading status checks…
c92c071 
Dockerfile tries to copy `geth` but it should copy `gexp` instead
@blueprintmrk blueprintmrk mentioned this issue Aug 30, 2019
Open
3 of 4 tasks complete
@han1025 han1025 mentioned this issue Nov 2, 2019
Open
3 of 4 tasks complete
@gracewdy gracewdy mentioned this issue Nov 10, 2019
Open
@tg-z tg-z mentioned this issue Nov 15, 2019
Open
3 of 4 tasks complete
@baronTommy baronTommy mentioned this issue Feb 6, 2020
Closed
1 of 5 tasks complete
@wran-09 wran-09 mentioned this issue Mar 3, 2020
Open
@krittiyaporn13 krittiyaporn13 mentioned this issue Mar 3, 2020
Open
@siwakorn23 siwakorn23 mentioned this issue Mar 3, 2020
Open
@nagib88 nagib88 mentioned this issue Apr 4, 2020
Merged
@noobdummy noobdummy mentioned this issue Apr 25, 2020
Open
3 of 4 tasks complete
@Tomes111 Tomes111 mentioned this issue May 26, 2020
Closed
@nickborromeo nickborromeo mentioned this issue Jun 3, 2020
Merged
3 of 4 tasks complete
@ORFEI-GRAP ORFEI-GRAP mentioned this issue Jun 3, 2020
Open
2 of 2 tasks complete
@RyoKawase RyoKawase mentioned this issue Jun 10, 2020
Closed
@MFaik MFaik mentioned this issue Jun 27, 2020
Merged
@sbibek086 sbibek086 mentioned this issue Aug 7, 2020
Open
@cristobalnic cristobalnic mentioned this issue Aug 13, 2020
Closed
@Bincell Bincell mentioned this issue Aug 24, 2020
Merged
@eduardodarocha eduardodarocha mentioned this issue Aug 25, 2020
Open
1 of 3 tasks complete
This was referenced Sep 4, 2020
Open
Open
@jimu jimu mentioned this issue Sep 23, 2020
Merged
@chakibbensari chakibbensari mentioned this issue Mar 10, 2021
Open
2 of 3 tasks complete
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet