From 57539d69e8ee1e86bd14c9e51273e576b2e38438 Mon Sep 17 00:00:00 2001
From: Artem Yunusov
This page offers a brief overview of what it's like to use Markdown. -The syntax pageprovides complete, detailed documentation for +The syntax page provides complete, detailed documentation for every feature, but Markdown should be very easy to pick up simply by looking at a few examples of it in action. The examples on this page are written in a before/after style, showing example syntax and the HTML output produced by Markdown.
-It's also helpful to simply try Markdown out; the Dingusis a +
It's also helpful to simply try Markdown out; the Dingus is a web application that allows you type your own Markdown-formatted text and translate it to XHTML.
-Note: This document is itself written using Markdown; you + Note: This document is itself written using Markdown; you can see the source for it by adding '.text' to the URL.
A paragraph is simply one or more consecutive lines of text, separated @@ -33,7 +33,7 @@ HTML header level.
Blockquotes are indicated using email-style '>
' angle brackets.
Markdown:
-A First Level Header
+ A First Level Header
====================
A Second Level Header
@@ -57,7 +57,7 @@ dog's back.
Output:
-<h1>A First Level Header</h1>
+ <h1>A First Level Header</h1>
<h2>A Second Level Header</h2>
@@ -83,7 +83,7 @@ dog's back.</p>
Markdown uses asterisks and underscores to indicate spans of emphasis.
Markdown:
-Some of these words *are emphasized*.
+ Some of these words *are emphasized*.
Some of these words _are emphasized also_.
Use two asterisks for **strong emphasis**.
@@ -92,7 +92,7 @@ Or, if you prefer, __use two underscores instead__.
Output:
-<p>Some of these words <em>are emphasized</em>.
+ <p>Some of these words <em>are emphasized</em>.
Some of these words <em>are emphasized also</em>.</p>
<p>Use two asterisks for <strong>strong emphasis</strong>.
@@ -104,28 +104,28 @@ Or, if you prefer, <strong>use two underscores instead</strong>.<
+
, and -
) as list markers. These three markers are
interchangable; this:
-* Candy.
+ * Candy.
* Gum.
* Booze.
this:
-+ Candy.
+ + Candy.
+ Gum.
+ Booze.
and this:
-- Candy.
+ - Candy.
- Gum.
- Booze.
all produce the same output:
-<ul>
+ <ul>
<li>Candy.</li>
<li>Gum.</li>
<li>Booze.</li>
@@ -135,25 +135,25 @@ interchangable; this:
Ordered (numbered) lists use regular numbers, followed by periods, as
list markers:
-1. Red
+ 1. Red
2. Green
3. Blue
Output:
-<ol>
+ <ol>
<li>Red</li>
<li>Green</li>
<li>Blue</li>
</ol>
-If you put blank lines between items, you'll get <p>
tags for the
+
If you put blank lines between items, you'll get <p>
tags for the
list item text. You can create multi-paragraph list items by indenting
the paragraphs by 4 spaces or 1 tab:
-* A list item.
+ * A list item.
With multiple paragraphs.
@@ -162,7 +162,7 @@ the paragraphs by 4 spaces or 1 tab:
Output:
-<ul>
+ <ul>
<li><p>A list item.</p>
<p>With multiple paragraphs.</p></li>
<li><p>Another item in the list.</p></li>
@@ -176,30 +176,30 @@ text you want to turn into a link.
Inline-style links use parentheses immediately after the link text.
For example:
-This is an [example link](http://example.com/).
+ This is an [example link](http://example.com/).
Output:
-<p>This is an <a href="http://example.com/">
+ <p>This is an <a href="http://example.com/">
example link</a>.</p>
Optionally, you may include a title attribute in the parentheses:
-This is an [example link](http://example.com/ "With a Title").
+ This is an [example link](http://example.com/ "With a Title").
Output:
-<p>This is an <a href="http://example.com/" title="With a Title">
+ <p>This is an <a href="http://example.com/" title="With a Title">
example link</a>.</p>
Reference-style links allow you to refer to your links by names, which
you define elsewhere in your document:
-I get 10 times more traffic from [Google][1] than from
+ I get 10 times more traffic from [Google][1] than from
[Yahoo][2] or [MSN][3].
[1]: http://google.com/ "Google"
@@ -209,16 +209,16 @@ you define elsewhere in your document:
Output:
-<p>I get 10 times more traffic from <a href="http://google.com/"
+ <p>I get 10 times more traffic from <a href="http://google.com/"
title="Google">Google</a> than from <a href="http://search.yahoo.com/"
title="Yahoo Search">Yahoo</a> or <a href="http://search.msn.com/"
title="MSN Search">MSN</a>.</p>
The title attribute is optional. Link names may contain letters,
-numbers and spaces, but are notcase sensitive:
+numbers and spaces, but are not case sensitive:
-I start my morning with a cup of coffee and
+ I start my morning with a cup of coffee and
[The New York Times][NY Times].
[ny times]: http://www.nytimes.com/
@@ -226,7 +226,7 @@ numbers and spaces, but are notcase sensitive:
Output:
-<p>I start my morning with a cup of coffee and
+ <p>I start my morning with a cup of coffee and
<a href="http://www.nytimes.com/">The New York Times</a>.</p>
@@ -234,19 +234,19 @@ numbers and spaces, but are notcase sensitive:
Image syntax is very much like link syntax.
Inline (titles are optional):
-![alt text](/path/to/img.jpg "Title")
+ ![alt text](/path/to/img.jpg "Title")
Reference-style:
-![alt text][id]
+ ![alt text][id]
[id]: /path/to/img.jpg "Title"
Both of the above examples produce the same output:
-<img src="/path/to/img.jpg" alt="alt text" title="Title" />
+ <img src="/path/to/img.jpg" alt="alt text" title="Title" />
Code
@@ -255,7 +255,7 @@ backtick quotes. Any ampersands (&
) and angle brackets (&
>
) will automatically be translated into HTML entities. This makes
it easy to use Markdown to write about HTML example code:
-I strongly recommend against using any `<blink>` tags.
+ I strongly recommend against using any `<blink>` tags.
I wish SmartyPants used named entities like `—`
instead of decimal-encoded entites like `—`.
@@ -263,7 +263,7 @@ instead of decimal-encoded entites like `—`.
Output:
-<p>I strongly recommend against using any
+ <p>I strongly recommend against using any
<code><blink></code> tags.</p>
<p>I wish SmartyPants used named entities like
@@ -273,10 +273,10 @@ entites like <code>&#8212;</code>.</p>
To specify an entire block of pre-formatted code, indent every line of
the block by 4 spaces or 1 tab. Just like with code spans, &
, <
,
-and >
characters will be escaped automatically.
+and >
characters will be escaped automatically.
Markdown:
-If you want your page to validate under XHTML 1.0 Strict,
+ If you want your page to validate under XHTML 1.0 Strict,
you've got to put paragraph tags in your blockquotes:
<blockquote>
@@ -286,7 +286,7 @@ you've got to put paragraph tags in your blockquotes:
Output:
-<p>If you want your page to validate under XHTML 1.0 Strict,
+ <p>If you want your page to validate under XHTML 1.0 Strict,
you've got to put paragraph tags in your blockquotes:</p>
<pre><code><blockquote>
@@ -295,3 +295,4 @@ you've got to put paragraph tags in your blockquotes:</p>
</code></pre>
+
--
cgit v1.2.3