PHP Classes

File: test/expect/Markdown-Documentation-Basics.html

Recommend this page to a friend!
  Classes of Manuel Lemos  >  PHP Markdown Parser  >  test/expect/Markdown-Documentation-Basics.html  >  Download  
File: test/expect/Markdown-Documentation-Basics.html
Role: Auxiliary data
Content type: text/plain
Description: Original test HTML output file by John Gruber
Class: PHP Markdown Parser
Parse Markdown documents and generate HTML tags
Author: By
Last change: Fixed the end of line buffer variable setting.
Date: 7 years ago
Size: 10,447 bytes
 

Contents

Class file image Download
<h1>Markdown: Basics</h1> <p></p> <p>&lt;ul id=&quot;ProjectSubmenu&quot;&gt; &lt;li&gt;&lt;a href=&quot;/projects/markdown/&quot; title=&quot;Markdown Project Page&quot;&gt;Main&lt;/a&gt;&lt;/li&gt; &lt;li&gt;&lt;a class=&quot;selected&quot; title=&quot;Markdown Basics&quot;&gt;Basics&lt;/a&gt;&lt;/li&gt; &lt;li&gt;&lt;a href=&quot;/projects/markdown/syntax&quot; title=&quot;Markdown Syntax Documentation&quot;&gt;Syntax&lt;/a&gt;&lt;/li&gt; &lt;li&gt;&lt;a href=&quot;/projects/markdown/license&quot; title=&quot;Pricing and License Information&quot;&gt;License&lt;/a&gt;&lt;/li&gt; &lt;li&gt;&lt;a href=&quot;/projects/markdown/dingus&quot; title=&quot;Online Markdown Web Form&quot;&gt;Dingus&lt;/a&gt;&lt;/li&gt; &lt;/ul&gt;</p> <p></p> <h2>Getting the Gist of Markdown's Formatting Syntax</h2> <p></p> <p>This page offers a brief overview of what it's like to use Markdown. The [syntax page] [s] 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.</p> <p>It's also helpful to simply try Markdown out; the [Dingus] [d] is a web application that allows you type your own Markdown-formatted text and translate it to XHTML.</p> <p><strong>Note:</strong> This document is itself written using Markdown; you can [see the source for it by adding '.text' to the URL] [src].</p> <p> [s]: /projects/markdown/syntax &quot;Markdown Syntax&quot; [d]: /projects/markdown/dingus &quot;Markdown Dingus&quot; [src]: /projects/markdown/basics.text</p> <p></p> <h2>Paragraphs, Headers, Blockquotes</h2> <p></p> <p>A paragraph is simply one or more consecutive lines of text, separated by one or more blank lines. (A blank line is any line that looks like a blank line -- a line containing nothing spaces or tabs is considered blank.) Normal paragraphs should not be intended with spaces or tabs.</p> <p>Markdown offers two styles of headers: <em>Setext</em> and <em>atx</em>. Setext-style headers for <code>&lt;h1&gt;</code> and <code>&lt;h2&gt;</code> are created by &quot;underlining&quot; with equal signs (<code>=</code>) and hyphens (<code>-</code>), respectively. To create an atx-style header, you put 1-6 hash marks (<code>#</code>) at the beginning of the line -- the number of hashes equals the resulting HTML header level.</p> <p>Blockquotes are indicated using email-style '<code>&gt;</code>' angle brackets.</p> <p>Markdown:</p> <pre><code>A First Level Header ==================== A Second Level Header --------------------- </code></pre><p></p> <pre><code>Now is the time for all good men to come to the aid of their country. This is just a regular paragraph. </code></pre><p></p> <pre><code>The quick brown fox jumped over the lazy dog's back. ### Header 3 </code></pre><p></p> <pre><code>&gt; This is a blockquote. &gt; &gt; This is the second paragraph in the blockquote. &gt; &gt; ## This is an H2 in a blockquote </code></pre><p></p> <p></p> <p>Output:</p> <pre><code>&lt;h1&gt;A First Level Header&lt;/h1&gt; &lt;h2&gt;A Second Level Header&lt;/h2&gt; &lt;p&gt;Now is the time for all good men to come to the aid of their country. This is just a regular paragraph.&lt;/p&gt; &lt;p&gt;The quick brown fox jumped over the lazy dog's back.&lt;/p&gt; &lt;h3&gt;Header 3&lt;/h3&gt; &lt;blockquote&gt; &lt;p&gt;This is a blockquote.&lt;/p&gt; &lt;p&gt;This is the second paragraph in the blockquote.&lt;/p&gt; &lt;h2&gt;This is an H2 in a blockquote&lt;/h2&gt; &lt;/blockquote&gt; </code></pre><p></p> <p></p> <p></p> <h3>Phrase Emphasis</h3> <p></p> <p>Markdown uses asterisks and underscores to indicate spans of emphasis.</p> <p>Markdown:</p> <pre><code>Some of these words <em>are emphasized</em>. Some of these words _are emphasized also_. Use two asterisks for <strong>strong emphasis</strong>. Or, if you prefer, __use two underscores instead__. </code></pre><p></p> <p>Output:</p> <pre><code>&lt;p&gt;Some of these words &lt;em&gt;are emphasized&lt;/em&gt;. Some of these words &lt;em&gt;are emphasized also&lt;/em&gt;.&lt;/p&gt; &lt;p&gt;Use two asterisks for &lt;strong&gt;strong emphasis&lt;/strong&gt;. Or, if you prefer, &lt;strong&gt;use two underscores instead&lt;/strong&gt;.&lt;/p&gt; </code></pre><p></p> <p></p> <p></p> <h2>Lists</h2> <p></p> <p>Unordered (bulleted) lists use asterisks, pluses, and hyphens (<code>*</code>, <code>+</code>, and <code>-</code>) as list markers. These three markers are interchangable; this:</p> <pre><code>* Candy. * Gum. * Booze. </code></pre><p></p> <p>this:</p> <pre><code>+ Candy. + Gum. + Booze. </code></pre><p></p> <p>and this:</p> <pre><code>- Candy. - Gum. - Booze. </code></pre><p></p> <p>all produce the same output:</p> <pre><code>&lt;ul&gt; &lt;li&gt;Candy.&lt;/li&gt; &lt;li&gt;Gum.&lt;/li&gt; &lt;li&gt;Booze.&lt;/li&gt; &lt;/ul&gt; </code></pre><p></p> <p>Ordered (numbered) lists use regular numbers, followed by periods, as list markers:</p> <pre><code>1. Red 2. Green 3. Blue </code></pre><p></p> <p>Output:</p> <pre><code>&lt;ol&gt; &lt;li&gt;Red&lt;/li&gt; &lt;li&gt;Green&lt;/li&gt; &lt;li&gt;Blue&lt;/li&gt; &lt;/ol&gt; </code></pre><p></p> <p>If you put blank lines between items, you'll get <code>&lt;p&gt;</code> tags for the list item text. You can create multi-paragraph list items by indenting the paragraphs by 4 spaces or 1 tab:</p> <pre><code>* A list item. With multiple paragraphs. </code></pre><p></p> <pre><code>* Another item in the list. </code></pre><p></p> <p>Output:</p> <pre><code>&lt;ul&gt; &lt;li&gt;&lt;p&gt;A list item.&lt;/p&gt; &lt;p&gt;With multiple paragraphs.&lt;/p&gt;&lt;/li&gt; &lt;li&gt;&lt;p&gt;Another item in the list.&lt;/p&gt;&lt;/li&gt; &lt;/ul&gt; </code></pre><p></p> <p></p> <h3>Links</h3> <p></p> <p>Markdown supports two styles for creating links: <em>inline</em> and <em>reference</em>. With both styles, you use square brackets to delimit the text you want to turn into a link.</p> <p>Inline-style links use parentheses immediately after the link text. For example:</p> <pre><code>This is an <a href="http://example.com/">example link</a>. </code></pre><p></p> <p>Output:</p> <pre><code>&lt;p&gt;This is an &lt;a href=&quot;http://example.com/&quot;&gt; example link&lt;/a&gt;.&lt;/p&gt; </code></pre><p></p> <p>Optionally, you may include a title attribute in the parentheses:</p> <pre><code>This is an <a href="http://example.com/ &quot;With a Title&quot;">example link</a>. </code></pre><p></p> <p>Output:</p> <pre><code>&lt;p&gt;This is an &lt;a href=&quot;http://example.com/&quot; title=&quot;With a Title&quot;&gt; example link&lt;/a&gt;.&lt;/p&gt; </code></pre><p></p> <p>Reference-style links allow you to refer to your links by names, which you define elsewhere in your document:</p> <pre><code>I get 10 times more traffic from [Google][1] than from [Yahoo][2] or [MSN][3]. </code></pre><p></p> <pre><code>[1]: http://google.com/ &quot;Google&quot; [2]: http://search.yahoo.com/ &quot;Yahoo Search&quot; [3]: http://search.msn.com/ &quot;MSN Search&quot; </code></pre><p></p> <p>Output:</p> <pre><code>&lt;p&gt;I get 10 times more traffic from &lt;a href=&quot;http://google.com/&quot; title=&quot;Google&quot;&gt;Google&lt;/a&gt; than from &lt;a href=&quot;http://search.yahoo.com/&quot; title=&quot;Yahoo Search&quot;&gt;Yahoo&lt;/a&gt; or &lt;a href=&quot;http://search.msn.com/&quot; title=&quot;MSN Search&quot;&gt;MSN&lt;/a&gt;.&lt;/p&gt; </code></pre><p></p> <p>The title attribute is optional. Link names may contain letters, numbers and spaces, but are <em>not</em> case sensitive:</p> <pre><code>I start my morning with a cup of coffee and [The New York Times][NY Times]. </code></pre><p></p> <pre><code>[ny times]: http://www.nytimes.com/ </code></pre><p></p> <p>Output:</p> <pre><code>&lt;p&gt;I start my morning with a cup of coffee and &lt;a href=&quot;http://www.nytimes.com/&quot;&gt;The New York Times&lt;/a&gt;.&lt;/p&gt; </code></pre><p></p> <p></p> <h3>Images</h3> <p></p> <p>Image syntax is very much like link syntax.</p> <p>Inline (titles are optional):</p> <pre><code><img alt="alt text" src="/path/to/img.jpg &quot;Title&quot;"> </code></pre><p></p> <p>Reference-style:</p> <pre><code>![alt text][id] </code></pre><p></p> <pre><code>[id]: /path/to/img.jpg &quot;Title&quot; </code></pre><p></p> <p>Both of the above examples produce the same output:</p> <pre><code>&lt;img src=&quot;/path/to/img.jpg&quot; alt=&quot;alt text&quot; title=&quot;Title&quot; /&gt; </code></pre><p></p> <p></p> <p></p> <h3>Code</h3> <p></p> <p>In a regular paragraph, you can create code span by wrapping text in backtick quotes. Any ampersands (<code>&amp;</code>) and angle brackets (<code>&lt;</code> or <code>&gt;</code>) will automatically be translated into HTML entities. This makes it easy to use Markdown to write about HTML example code:</p> <pre><code>I strongly recommend against using any <code>&lt;blink&gt;</code> tags. </code></pre><p></p> <pre><code>I wish SmartyPants used named entities like <code>&amp;mdash;</code> instead of decimal-encoded entites like <code>&amp;#8212;</code>. </code></pre><p></p> <p>Output:</p> <pre><code>&lt;p&gt;I strongly recommend against using any &lt;code&gt;&amp;lt;blink&amp;gt;&lt;/code&gt; tags.&lt;/p&gt; &lt;p&gt;I wish SmartyPants used named entities like &lt;code&gt;&amp;amp;mdash;&lt;/code&gt; instead of decimal-encoded entites like &lt;code&gt;&amp;amp;#8212;&lt;/code&gt;.&lt;/p&gt; </code></pre><p></p> <p></p> <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, <code>&amp;</code>, <code>&lt;</code>, and <code>&gt;</code> characters will be escaped automatically.</p> <p>Markdown:</p> <pre><code>If you want your page to validate under XHTML 1.0 Strict, you've got to put paragraph tags in your blockquotes: </code></pre><p></p> <pre><code>&lt;blockquote&gt; &lt;p&gt;For example.&lt;/p&gt; &lt;/blockquote&gt; </code></pre><p></p> <p>Output:</p> <pre><code>&lt;p&gt;If you want your page to validate under XHTML 1.0 Strict, you've got to put paragraph tags in your blockquotes:&lt;/p&gt; &lt;pre&gt;&lt;code&gt;&amp;lt;blockquote&amp;gt; &amp;lt;p&amp;gt;F</code></pre><pre><code>&amp;lt;/blockquote&amp;gt; &lt;/code&gt;&lt;/pre&gt; </code></pre>