aboutsummaryrefslogtreecommitdiff
path: root/README.html
diff options
context:
space:
mode:
Diffstat (limited to 'README.html')
-rw-r--r--README.html64
1 files changed, 30 insertions, 34 deletions
diff --git a/README.html b/README.html
index db825c2..a96b35c 100644
--- a/README.html
+++ b/README.html
@@ -5,13 +5,12 @@ Em is a limited hypertext markup language.
It is similar to Markdown, but it has a few key advantages:
</p>
<ol>
-<li value="1">It is more readable.
-</li><li value="2">It is simpler to parse.
-</li><li value="3">There is <i>not</i> more than one way to do it (sorry Larry).
-</li>
+ 1. It is more readable.
+ 2. It is simpler to parse.
+ 3. There is *not* more than one way to do it (sorry Larry).
</ol>
<p>
-Em takes plain-text readability seriously. You should be able to
+Em takes plain-text readability seriously. You should be able to
write em in a plain-text e-mail message without the recipient noticing.
</p>
<p>
@@ -21,17 +20,17 @@ for the benefits of em.
<h2>Syntax</h2>
<h3>Block-level formatting</h3>
<p>
-<i>A single empty line</i> always marks a block break. There is
-no exception to this rule. The line is removed in the final output.
+*A single empty line* always marks a block break. There is
+no exception to this rule. The line is removed in the final output.
</p>
<p>
All blocks support inline formatting, except headings,
preformatted blocks and terms in definition lists.
</p>
<p>
-One block cannot be put within another block. For example,
+One block cannot be put within another block. For example,
it is impossible to put a paragraph or a preformatted block
-inside a list item. If you want paragraph lists, just use paragraphs:
+inside a list item. If you want paragraph lists, just use paragraphs:
</p>
<pre>
1. Lorem ipsum dolor sit amet, consectetur adipiscing elit,
@@ -53,10 +52,10 @@ Headings begin and end with the same number of equal signs:
</pre>
<h4>Lists</h4>
<p>
-Lists start with a single space. There are four types of lists:
+Lists start with a single space. There are four types of lists:
</p>
<pre>
-<li>This is an unordered list
+ - This is an unordered list
- With two items
1. This is an ordered list
@@ -64,43 +63,41 @@ Lists start with a single space. There are four types of lists:
two lines
this is: a definition list
-</li>
</pre>
<pre>
-<li value="1" id="ref1">This is a reference list
+ [1] This is a reference list
[2] With two items
-</li>
</pre>
<p>
-Unordered and ordered lists can be nested. An additional space
+Unordered and ordered lists can be nested. An additional space
at the beginning of the line increases the item level by one:
</p>
<pre>
-<li>First level
+ - First level
- Second level
- First level
-</li>
</pre>
<p>
-A reference list is a special type of list, unique to em. It is a
+A reference list is a special type of list, unique to em. It is a
type of footnote list, to which you can make inline referencess
like this:
</p>
<pre>
-See footnote [<a href="#ref1">1</a>].
+See footnote [1].
</pre>
<p>
-There is a special type of reference list item called a <i>hyperlink
-reference</i>. It contains only a single word, without whitespace:
+There is a special type of reference list item called a *hyperlink
+reference*. It contains only a single word, without whitespace:
</p>
<pre>
+ [1] http://example.com
</pre>
<p>
Hyperlink reference items are removed in the final output,
but you can still reference them inline:
</p>
<pre>
-You can download the file here [<a href="#ref1">1</a>].
+You can download the file here [1].
</pre>
<h4>Preformatted blocks</h4>
<p>
@@ -123,37 +120,36 @@ This is another paragraph.
</pre>
<h3>Inline formatting</h3>
<p>
-<b>Italic, bold and teletype text</b> is marked with the asterisk,
+_Italic, bold and teletype text_ is marked with the asterisk,
the underscore and the backtick, respectively:
</p>
<pre>
-Example of <i>italic</i> text.
+Example of *italic* text.
</pre>
<p>
The marks are only valid in certain positions:
</p>
<ol>
-<li value="1">At word borders
-</li><li value="2">After an opening parenthesis
-</li><li value="3">Before any of <tt>.,:;?!)</tt>
-</li><li value="4">Before a closing parenthesis any of <tt>.,:;?!</tt>
-</li>
+ 1. At word borders
+ 2. After an opening parenthesis
+ 3. Before any of `.,:;?!)`
+ 4. Before a closing parenthesis any of `.,:;?!`
</ol>
<p>
-<b>Inline references</b> are created with square brackets:
+_Inline references_ are created with square brackets:
</p>
<pre>
-Example of an inline reference [<a href="#ref12">12</a>].
+Example of an inline reference [12].
</pre>
<p>
They are valid in positions 1, 3 and 4.
</p>
<p>
When referencing a hyperlink reference (see above),
-the reference is replaced with a link. For example:
+the reference is replaced with a link. For example:
</p>
<pre>
-It is available for download [<a href="#ref1">1</a>].
+It is available for download [1].
[1] v1.tgz
</pre>
@@ -166,5 +162,5 @@ translates into the following HTML:
</pre>
<p>
The default link text ("link") can be changed by setting
-the <tt>linktext</tt> environment variable.
+the `linktext` environment variable.
</p>