Diaspora*/markup

From Griki
Jump to: navigation, search

Basic markup description

You can format text in posts and comments by using a simple text markup:

Blank lines separate paragraphs.

  • italic:
    • *my text* → my text
    • _my text_ → my text
  • bold:
    • **my text** → my text
    • __my text__ → my text
  • italic and bold:
    • ***my text*** → my text
    • ___my text___ → my text

links

  • [text here](url here)
    • [text here](url here "hover text here")
  • <url here>, <email@example.com>


Reference Links

You can also put the [link URL][1] below the current paragraph like [this][2].

  [1]: http://url
  [2]: http://another.url "A funky title"

Here the text "link URL" gets linked to "http://url", and the lines showing "[1]: http://url" won't show anything.


Or you can use a [shortcut][] reference, which links the text "shortcut" to the link named "[shortcut]" on the next paragraph.

  [shortcut]: http://goes/with/the/link/name/text
  

Blockquotes

> Use the > character in front of a line, *just like in email*. > Use it if you're quoting a person, a song or whatever.

> You can use *italic* or lists inside them also. And just like with other paragraphs, all of these lines are still part of the blockquote, even without the > character in front.

To end the blockquote, just put a blank line before the following paragraph.


Preformatted Text

If you want some text to show up exactly as you write it, without Markdown doing anything to it, just indent every line by at least 4 spaces (or 1 tab).

   This line won't *have any markdown* formatting applied.
   I can even write HTML and it will show up as text.
   This is great for showing program source code, or HTML or even Markdown.
   this won't show up as HTML but exactly as you see it in
   this text file.

(In a normal paragraph, this will show up in bold just like normal HTML.)

  Remember, you have to indent by *at least 4 spaces* to do it.  This paragraph
  won't be preformatted.
  

And if you use [reference][] links, make sure the links are indented by *fewer than* 4 spaces.

   [reference]: http://example.com/blah

(woops, that link didn't work, see? It just got displayed as preformatted text.)

As a shortcut you can use backquotes to do the same thing while inside a normal pargraph. `This won't be *italic* or **bold** at all.`

Lists

  • an asterisk starts an unordered list
  • and this is another item in the list

+ or you can also use the + character - or the - character

To start an ordered list, write this:

1. this starts a list *with* numbers + this will show as number "2"

  • this will show as number "3."

9. any number, +, -, or * will keep the list going.

   * just indent by 4 spaces (or tab) to make a sub-list
       1. keep indenting for more sub lists
   * here i'm back to the second level
       
       

Headers

This is a huge header ==================

this is a smaller header ------------------

Just put 1 or more dashes or equals signs (--- or ===) below the title.

You might use the huge header at the very top of your text for a title or something (except weblog posts usually already have a title), and use the smaller header for subtitles or sections.


Horizontal Rule

just put three or more *'s or -'s on a line:


or you can use single spaces between then, like this:

  • * *

or

- - - - - - -

Make sure you have a blank line above the dashes, though, or else:

you will get a header ---


Images

To include an image, just put a "!" in front of a text link:

![alternate text](http://someurl/image.gif)


The "alternate text" will show up if the browser can't load the image.

You can also use a title if you want, like this:

![tiny arrow](http://greg.vario.us/img/extlink.png "tiny arrow")


Escapes


What if you want to just show asterisks, not italics?

  • this shows up in italics: *a happy day*
  • this shows the asterisks: \*a happy day\*

The backslashes will disappear and leave the asterisks.

You can do the same with any of the characters that have a special meaning for Markdown.


More Headers


More ways of doing headers:

  1. this is a huge header #
    1. this is a smaller header ##
      1. this is even smaller ###
        1. more small ####
          1. even smaller #####
            1. smallest still: `
              ` header

You can use up to 6 `#` characters at the beginning of the line. (You can optionally put them on the end, too, and they will disappear.)


HTML stuff


Don't worry about special HTML characters. I can write an ampersand & a less-than sign, and they show up as I intend them to: 3 < 4.

(You can still write `&` (& character) and `<` (<) or `>` (>) if you

want. or ignore what I just said.)