improve markdown quick reference

rstudio · Apr 17, 2012 · baae90d · baae90d
1 parent e87bff6
commit baae90d
Showing 1 changed file with 18 additions and 3 deletions.
diff --git a/src/cpp/session/resources/markdown_help.htm b/src/cpp/session/resources/markdown_help.htm
@@ -41,7 +41,7 @@
 
 <body>
 
-<h2>Markdown Quick Reference</h2>
+<h3>Markdown Quick Reference</h3>
 
 <div id="overview">
 <p>
@@ -91,7 +91,7 @@ <h4>Links</h4>
 </code></pre>
 
 <h4>Images</h4>
-<pre><code>![Example Logo](http://example.com/logo.png)
+<pre><code>![alt text](figures/img.png "Title")
 </code></pre>
 
 <h4>Blockquotes</h4>
@@ -117,9 +117,24 @@ <h4>Inline Code</h4>
 <h4>Horizontal Rule / Page Break</h4>
 <p>Three or more asterisks or dashes:</p>
 <pre><code>******
+
 ------
 </code></pre>
 
+<h4>Reference Style Links and Images</h4>
+<p>Links (titles optional):</p>
+<pre><code>An [example][id]. Then, anywhere
+else in the doc, define the link:
+
+  [id]: http://example.com/  "Title"
+</code></pre>
+
+<p>Images (titles optional):</p>
+<pre><code>![alt text][id]
+
+[id]: figures/img.png "Title"
+</code></pre>
+
 <h4>Tables</h4>
 <pre><code>First Header  | Second Header
 ------------- | -------------
@@ -132,7 +147,7 @@ <h4>Miscellaneous</h4>
 </code></pre>
 
 <h4>Smartypants</h4>
-<p>Plain ASCII punctuation characters (e.g. dashes, quotes, etc.) are transormed into smart typographic punctuation HTML entities. Cmmon symbols including copyright and trademark are also transformed.</p>
+<p>Plain ASCII punctuation characters (e.g. dashes, quotes, etc.) are translated into smart typographic punctuation HTML entities. Common symbols including copyright and trademark are also translated.</p>
 
 </div>