Markdown Examples...



  • Headers

    MarkdownResult
    An h1 Header
    ============
    
    # Alternate Syntax for H1
    

    An h1 Header

    Alternate Syntax for H1

    Ah h2 Header
    -----------------
    
    ## Alternate Syntax for H2
    

    Ah h2 Header

    Alternate Syntax for H2

    ### An h3 Header
    

    An h3 Header

    Headers exist for H4 and H5, also. Use four and five hashes, respectively. Note there must be a space between the hashes and the text.

    Text styles, unordered lists, block quotes

    Paragraphs are separated by a blank line.

    MarkdownResult
    *Italic*, **bold**, and `monospace`. 
    
    Itemized lists look like:
    
      * this one
      * that one
      * the other one
        ^
        | column four
    
    Line breaks in
    text are 
    honored, also.  
    

    Italic, bold, and monospace.

    Itemized lists look like:

    • this one
    • that one
    • the other one

    Note that - not considering the asterisk - the actual text content starts at four columns in.

    Line breaks in
    text are
    honored, also.

    Unicode characters are supported. ☺

    MarkdownResult
    > Block quotes are written like so.
    >>
    >>Doubly nested quotes are possible.
    >
    > They can span multiple paragraphs, if you like.
    

    Block quotes are written like so.

    Doubly nested quotes are possible.

    They can span multiple paragraphs, if you like.


    Ordered lists

    MarkdownResult
    Here's a numbered list:
    
     1. first item
     1. second item
        1. nested item
        1. nested item
     1. third item
    

    (numbering of the list is arbitrary, they can all be #1
    and will be auto numbered in the list.)

    Here's a numbered list:

    1. first item
    2. second item
      1. nested item
      2. nested item
    3. third item

    Code Blocks

    Note again how the actual text starts at five columns in (five characters from the left side). Any block of text indented with four spaces will be automatically converted to a code block. Here's a code sample:

    MarkdownResult
    four spaces
    -----------
    sp sp sp sp # Let me re-iterate ...
    sp sp sp sp for i in 1 .. 10 { do-something(i) }
                ^
                | column five
    
    # Let me re-iterate ...
    for i in 1 .. 10 { do-something(i) }
    

    As you probably guessed, indented 4 spaces. By the way, instead of indenting the block, you can use delimited blocks, if you like:

    ~ ~ ~ (three tildes, but no spaces between)
    define foobar() {
        print "Welcome to flavor country!";
    }
    ~ ~ ~
    

    (which makes copying & pasting easier). You can optionally mark the delimited block for syntax highlighting:

    ~ ~ ~python  (again, no spaces between the tildes)
    import time
    # Quick, count to ten!
    for i in range(10):
        # (but not *too* quick)
        time.sleep(0.5)
        print i
    ~ ~ ~
    

    The examples above show the tildes with spaces between just so they'll show up in the formatted output, otherwise it just notes it as the start or end of another block.

    Nested Lists

    MarkdownResult
    Now a nested list:
    
     1. First, get these ingredients:
          * carrots
          * celery
          * lentils
    
     2. Boil some water.
    
     3. Dump everything in the pot and follow
        this algorithm:
    
            find wooden spoon
            uncover pot
            stir
            cover pot
            balance wooden spoon precariously on pot handle
            wait 10 minutes
            goto first step (or shut off burner when done)
    
        Do not bump wooden spoon or it will fall.
    

    Now a nested list:

    1. First, get these ingredients:

      • carrots
      • celery
      • lentils
    2. Boil some water.

    3. Dump everything in the pot and follow
      this algorithm:

      find wooden spoon
      uncover pot
      stir
      cover pot
      balance wooden spoon precariously on pot handle
      wait 10 minutes
      goto first step (or shut off burner when done)
      

      Do not bump wooden spoon or it will fall.

    Notice again how text always lines up on 4-space indents (including that last line which continues item 3 above).

    Links

    MarkdownResult
    Here's a link to [a website](http://foo.bar), 
    to a [local doc](local-doc.html), 
    and to a [section heading in the current doc](#an-h2-header). 
    

    Here's a link to a website,
    to a local doc,
    and to a section heading in the current doc.

    Tables

    Tables can look like this:

    MarkdownResult
    | size | material    | color        |
    |:----:|-------------|-------------:|
    |9     | leather     | brown        |
    |10    | hemp canvas | natural      |
    |11    | glass       | transparent  |
    

    Alignment can be controlled by the placement of ":" in the
    dashes line. :-----: for centered, ------: for right
    alignment. Default is left.

    size material color
    9 leather brown
    10 hemp canvas natural
    11 glass transparent

    Table: Shoes, their sizes, and what they're made of

    Colored Text

    In the toolbar above the editing window, there's an eyedropper on the far right. Select your text, then click the dropper, select a color, then click the little color wheel looking button in the bottom right of the popup. You can make RED TEXT!

    Alternately, if you know the HTML color code, you can just type it directly as in the below example.

    Warning: Changing the colors can produce text that's unreadable on some themes. Not everybody uses the same theme as YOU.

    MarkdownResult
    Create some %(#33FF33)[Green] text.
    HTML color names are supported for %(red)[text] also.
    And %(#888)[short color] specs, also.
    

    Create some Green text.
    HTML color names are supported for text also.
    And short color specs, also.

    Misc

    MarkdownResult
    A horizontal rule follows.  
    _(can be hard to see in some themes, but adds a break none the less)_
     ****
    
    Emoticons:  :smile:, :frowning:, :wink: , etc.  
    

    A horizontal rule follows. (can be hard to see in some themes, but adds a break none the less)


    Emoticons: 😄, 😦, 😉 , etc. 🙂

    Horizontal rules can be either multiple asterisks or dashes on a line by itself.

    When you type a colon, the emoticon picker pops up, and you can start typing to narrow the list :smile: for example, just type colon, then 's', then 'm' and pick from the list.


Log in to reply