8
0
daux.io/docs/01_Features/CommonMark_compliant.md
Stéphane Goetz 59b8c04161 Confluences bugfixes, Fix documentation
Make it easier to spot where an error comes from when uploading to confluence.
Allow to upload documentation without a prefix.
2017-11-06 22:46:07 +01:00

3.2 KiB

As we support CommonMark, a broad range of markdown features is available to you.

Many of the features shown below were known as Github Flavored Markdown.

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

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?

<div class="footer">
    &copy; 2004 Foo Corporation
</div>

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

ID Name Rank
1 Tom Preston-Werner Awesome
2 Albert Einstein Nearly as awesome

Crazy linking action

I get 10 times more traffic from [Google] 1 than from [Yahoo] 2 or [MSN] 3.

Images

Here's an image.

This is an image

Note: to use images on a landing page (index.md), prefix the image URL with the name of the directory it appears in, omitting the numerical prefix used to order the sections. For example in this section, to display this image on the landing page (index.md), the URL for the image would be "Features/sampleimage.png" to display the same image.

View the source of this content.